feat: OpenAPI 契约对齐与框架优化
All checks were successful
构建并部署到测试环境(无 SSH) / build-and-deploy (push) Successful in 5m45s

主要变更:
1. OpenAPI 文档契约对齐
   - 统一错误响应字段名为 msg(非 message)
   - 规范 envelope 响应结构(code, msg, data, timestamp)
   - 个人客户路由纳入文档体系(使用 Register 机制)
   - 新增 BuildDocHandlers() 统一管理 handler 构造
   - 确保文档生成的幂等性

2. Service 层错误处理统一
   - 全面替换 fmt.Errorf 为 errors.New/Wrap
   - 统一错误码使用规范
   - Handler 层参数校验不泄露底层细节
   - 新增错误码验证集成测试

3. 代码质量提升
   - 删除未使用的 Task handler 和路由
   - 新增代码规范检查脚本(check-service-errors.sh)
   - 新增注释路径一致性检查(check-comment-paths.sh)
   - 更新 API 文档生成指南

4. OpenSpec 归档
   - 归档 openapi-contract-alignment 变更(63 tasks)
   - 归档 service-error-unify-core 变更
   - 归档 service-error-unify-support 变更
   - 归档 code-cleanup-docs-update 变更
   - 归档 handler-validation-security 变更
   - 同步 delta specs 到主规范文件

影响范围:
- pkg/openapi: 新增 handlers.go,优化 generator.go
- internal/service/*: 48 个 service 文件错误处理统一
- internal/handler/admin: 优化参数校验错误提示
- internal/routes: 个人客户路由改造,删除 task 路由
- scripts: 新增 3 个代码检查脚本
- docs: 更新 OpenAPI 文档(15750+ 行)
- openspec/specs: 同步 3 个主规范文件

破坏性变更:无
向后兼容:是
This commit is contained in:
2026-01-30 11:40:36 +08:00
parent 1290160728
commit 409a68d60b
88 changed files with 27358 additions and 990 deletions

View File

@@ -0,0 +1,43 @@
## MODIFIED Requirements
### Requirement: 参数校验错误不泄露内部细节
系统在处理参数校验失败时 SHALL 避免向客户端泄露校验细节(字段名、规则表达式等),以减少对外暴露内部实现并保持错误语义稳定。
#### Scenario: validator 校验失败的对外返回
- **WHEN** Handler 使用 validator 对请求参数进行校验且校验失败
- **THEN** Handler 对外仅返回 `errors.New(errors.CodeInvalidParam)`
- **AND** 响应的 `msg` 为统一短消息(例如“参数验证失败”)
- **AND** 不拼接或直接返回 `validator``err.Error()`
#### Scenario: 校验细节仅写入日志
- **WHEN** 参数校验失败
- **THEN** 系统在日志中记录完整的校验错误细节(用于排查)
- **AND** 日志字段包含请求路径、请求方法、request_id如可用
## ADDED Requirements
### Requirement: Service 对外错误必须结构化
Service 层 SHALL 对外返回结构化错误AppError以确保全局 ErrorHandler 能正确区分 4xx 业务错误与 5xx 系统错误。
#### Scenario: 预期业务错误返回 4xx
- **WHEN** Service 发生可预期的业务错误(例如:验证码错误/过期、状态不允许、资源不存在)
- **THEN** 返回 `errors.New(<4xx-code>[, message])`
- **AND** 全局 ErrorHandler 将其映射为对应的 4xx HTTP 状态码
#### Scenario: 非预期系统错误返回 5xx
- **WHEN** Service 调用数据库/缓存/队列/第三方依赖发生错误
- **THEN** 返回 `errors.Wrap(<5xx-code>, err, "业务动作失败")`
- **AND** 客户端响应 `msg` 为错误码映射表中的通用描述(不包含底层 err 细节)
#### Scenario: 禁止 fmt.Errorf 作为对外错误
- **WHEN** Service 需要对外返回错误
- **THEN** 不使用 `fmt.Errorf(...)` 作为返回值
- **AND** 必须转换为 `errors.New(...)``errors.Wrap(...)`

View File

@@ -0,0 +1,28 @@
## MODIFIED Requirements
### Requirement: OpenAPI 响应结构与运行时一致
系统生成的 OpenAPI 文档 SHALL 反映真实运行时的统一响应 envelope成功与失败均一致
#### Scenario: 成功响应使用统一 envelope
- **WHEN** OpenAPI 生成器为任一接口生成 200 响应 schema
- **THEN** 响应结构包含 `code``msg``data``timestamp`
- **AND** `data` 字段的 schema 使用该接口的业务 DTO保持类型信息
#### Scenario: 错误响应使用统一 envelope
- **WHEN** OpenAPI 生成器为任一接口生成标准错误响应4xx/5xx
- **THEN** 错误响应结构包含 `code``msg``data``timestamp`
- **AND** 字段名使用 `msg`(不使用 `message`
### Requirement: OpenAPI 文档覆盖所有真实路由
系统生成的 OpenAPI 文档 SHALL 覆盖所有实际注册的 HTTP 路由,避免“路由存在但文档缺失”。
#### Scenario: 个人客户路由纳入文档
- **WHEN** 注册 `/api/c/v1` 个人客户相关路由
- **THEN** 路由注册应使用项目统一的 `Register(...)` 机制
- **AND** OpenAPI 文档包含对应路径与方法