/microservice

这是一个基于Spring Boot和Spring Cloud的微服务项目,包含API网关、用户服务和公共模块,并集成了Swagger2文档。

Primary LanguageJava

微服务示例项目

这是一个基于Spring Boot和Spring Cloud的微服务项目,包含API网关、用户服务和公共模块,并集成了Swagger2文档。

项目结构

microservice-demo/
├── api-gateway/        # API网关服务
├── user-service/       # 用户服务
├── common/             # 公共模块
└── pom.xml             # 父POM文件

技术栈

  • Spring Boot 2.7.5
  • Spring Cloud 2021.0.5
  • Spring Cloud Gateway
  • Spring Data JPA
  • H2 Database
  • Swagger2 / SpringFox 3.0.0
  • Lombok
  • Maven

功能特性

  • 基于Spring Cloud Gateway的API网关
  • 用户服务提供基本的CRUD操作
  • 统一的API响应格式
  • 全局异常处理
  • Swagger2 API文档

运行项目

前提条件

  • JDK 11+
  • Maven 3.6+

构建项目

mvn clean install

运行服务

  1. 首先启动Eureka服务注册中心
cd eureka-server
mvn spring-boot:run
  1. 启动用户服务
cd user-service
mvn spring-boot:run
  1. 启动API网关
cd api-gateway
mvn spring-boot:run

API文档

启动服务后,可以通过以下URL访问Swagger API文档:

API示例

用户API

创建用户

POST /api/users

请求体:

{
  "username": "zhangsan",
  "password": "password123",
  "email": "zhangsan@example.com",
  "fullName": "张三"
}

获取所有用户

GET /api/users

获取单个用户

GET /api/users/{id}

更新用户

PUT /api/users/{id}

请求体:

{
  "username": "zhangsan",
  "email": "zhangsan@example.com",
  "fullName": "张三"
}

删除用户

DELETE /api/users/{id}

注意事项

  • 本项目使用H2内存数据库,重启服务后数据会丢失