moamenhady/greatblogs-api

GreatBlogs API

这是一个基于Spring Boot、Spring Data、Spring Security和PostgreSQL开发的RESTful API，用于构建简单博客引擎。

目录

• 核心功能
• 快速开始
  • 前提条件
  • 获取镜像
  • 配置说明
• 使用方法
• API端点
• 认证方式
• 许可证

核心功能

• 支持博客文章的创建、读取、更新和删除（CRUD）操作
• 基于Basic Authentication的用户认证机制
• 使用Bcrypt进行安全密码存储
• 通过PostgreSQL数据库实现博客数据的持久化存储

快速开始

前提条件

确保您的环境中已安装以下工具：

• Docker
• Docker Compose（可选）

获取镜像

拉取GreatBlogs API Docker镜像：

bash
docker pull moamenhady/greatblogs-api:latest

配置说明

通过环境变量配置应用参数，主要配置项如下：

使用方法

基本运行方式

使用Docker命令直接运行容器（需提前确保PostgreSQL数据库可用）：

bash
docker run -d \
  -p 8080:8080 \
  -e SPRING_DATASOURCE_URL=jdbc:postgresql://db-host:5432/blogdb \
  -e SPRING_DATASOURCE_USERNAME=bloguser \
  -e SPRING_DATASOURCE_PASSWORD=blogpass \
  --name greatblogs-api \
  moamenhady/greatblogs-api:latest

Docker Compose 部署

创建docker-compose.yml文件：

yaml
version: '3.8'

services:
  api:
    image: moamenhady/greatblogs-api:latest
    ports:
      - "8080:8080"
    environment:
      - SPRING_DATASOURCE_URL=jdbc:postgresql://db:5432/greatblogs
      - SPRING_DATASOURCE_USERNAME=postgres
      - SPRING_DATASOURCE_PASSWORD=postgres
    depends_on:
      - db
    restart: unless-stopped

  db:
    image: postgres:16-alpine
    ports:
      - "5432:5432"
    environment:
      - POSTGRES_DB=greatblogs
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres
    volumes:
      - postgres-data:/var/lib/postgresql/data
    restart: unless-stopped

volumes:
  postgres-data:

启动服务：

bash
docker-compose up -d

API服务将在 http://localhost:8080 可用。

API端点

除/authors/signup外，所有端点均需认证。

作者相关

• POST /api/authors/signup：注册新作者账户，需提供用户名、密码和***
• GET /api/authors/all：获取所有作者的用户名列表
• GET /api/authors/{id}：获取指定ID的作者详情
• PUT /api/authors/update/{id}：更新作者的全名（fullName）和简介（about）信息

文章相关

• POST /api/posts/create：创建新博客文章
• GET /api/posts/all：获取所有博客文章
• GET /api/posts/{id}：获取指定ID的博客文章
• PUT /api/posts/update/{id}：更新指定ID的博客文章
• DELETE /api/posts/delete/{id}：删除指定ID的博客文章

认证方式

API使用Basic Authentication，请求需包含Authorization头，格式为Basic base64(用户名:密码)。

示例（使用curl）：

bash
curl -X GET -H "Authorization: Basic dXNlcjpwYXNzd29yZA==" http://localhost:8080/api/authors/all

（其中dXNlcjpwYXNzd29yZA==是user:password的Base64编码结果）

许可证

本项目基于 MIT许可证 授权。