ChronicDisease_SpringBoot/docs/DevRule/03-API设计规范.md

API设计规范

概述

本规范基于项目现有代码实现，定义了API接口的设计原则和标准。所有API必须遵循RESTful设计理念，确保接口的一致性、可维护性和易用性。

基本原则

1. RESTful设计：使用RESTful风格的URL路径，资源导向的设计理念。
2. 统一响应格式：所有API响应必须使用统一的R<T>格式。
3. 状态码规范：使用HTTP状态码和业务状态码相结合的方式。
4. 认证授权：采用Token-based认证机制。
5. 错误处理：统一的异常处理机制。

URL路径设计

1. 路径结构：

   • 使用小写字母和连字符（-）分隔单词
   • 路径格式：/{resource}/{action} 或 /{resource}/{id}/{action}
   • 示例：/geo/nearest, /get_openid, /user_info

2. 控制器映射：

   • 使用@RequestMapping("/{module}")定义模块路径
   • 子路径使用@GetMapping, @PostMapping等注解

HTTP方法

• GET：查询操作，用于获取资源
• POST：创建或执行操作，用于提交数据或执行动作
• PUT：更新操作（项目中暂未使用）
• DELETE：删除操作（项目中暂未使用）

请求格式

1. Content-Type：

   • JSON请求：application/json
   • 使用@RequestBody注解接收JSON数据

2. 参数传递：

   • 查询参数：使用@RequestParam
   • 请求体：使用@RequestBody
   • 路径参数：使用@PathVariable（项目中暂未使用）

响应格式

1. 统一响应类：R<T>

   {
      "code": Integer,    // 状态码
      "message": String,  // 响应消息
      "data": T          // 响应数据，可为空
   }
   

2. 成功响应：

   • 状态码：200
   • 使用R.success(code, message, data)构造

3. 失败响应：

   • 状态码：400（参数错误）、500（服务器错误）
   • 使用R.fail(code, message)构造

状态码规范

1. 成功状态码：

   • 200：操作成功
   • 具体业务成功码定义在SuccessResultCode枚举中

2. 失败状态码：

   • 400：参数校验异常、请求参数错误
   • 500：服务器内部错误
   • 具体业务失败码定义在FailResultCode枚举中

3. 异常状态码：

   • 定义在ExceptionResultCode枚举中
   • 400：参数校验异常、系统异常

认证与授权

1. 认证方式：

   • 优先使用标准Authorization header：Authorization: Bearer <token>
   • 向后兼容支持：X-Token 或 token header
   • 支持POST body中的token字段

2. 拦截器配置：

   • AuthInterceptor负责Token校验
   • 排除路径：/、/get_openid、Swagger相关路径

3. Token管理：

   • 使用TokenService生成和校验Token
   • 校验通过后将userId放入request属性

错误处理

1. 全局异常处理器：CustomExceptionHandler

   • 处理BindException：参数绑定异常
   • 处理ConstraintViolationException：约束违反异常
   • 处理CustomException：自定义业务异常
   • 处理Exception：未知异常

2. 异常响应：

   • 统一返回R.fail(code, message)格式
   • 记录错误日志

分页处理

1. 分页类：Page<T>

   {
      "pageNum": int,     // 当前页码
      "pageSize": int,    // 每页大小
      "total": long,      // 总记录数
      "list": List<T>     // 数据列表
   }
   

2. 分页插件：使用pagehelper实现分页

   • 配置在application.yml中
   • 数据库方言：MySQL

跨域配置

1. CORS配置：CorsConfig
   • 允许路径：/api/**
   • 允许源：http://localhost:3000
   • 允许方法：GET, POST, PUT, DELETE, OPTIONS
   • 允许凭证：true

API文档

1. 文档工具：使用Knife4j（基于Swagger）

   • 配置在Knife4jConfig中
   • 访问路径：/doc.html

2. 字段描述：

   • 使用@Schema注解描述请求/响应字段

   • 示例：

     @Schema(description = "更新用户信息请求")
     public class UpdateUserInfoRequest {
     @Schema(description = "头像（可选）")
     private String avatar;
     }
     

安全考虑

1. 输入验证：使用Bean Validation注解
2. SQL注入防护：使用MyBatis-Plus预编译
3. XSS防护：前端负责，API层不额外处理
4. 敏感信息：不在日志中记录Token等敏感信息

版本控制

• 当前API版本：v0
• 版本信息在Swagger配置中定义
• 未来版本升级时，可通过URL路径前缀区分（如/v1/、/v2/）

性能优化

1. 连接池：使用HikariCP数据库连接池
2. 缓存：根据业务需要添加缓存机制（项目中暂未实现）
3. 异步处理：对于耗时操作可考虑异步处理（项目中暂未使用）

测试规范

• API接口应编写单元测试和集成测试
• 测试应覆盖正常流程和异常情况
• 使用Mock框架模拟依赖服务