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 个主规范文件 破坏性变更:无 向后兼容:是
1.6 KiB
1.6 KiB
归档说明
归档时间:2026-01-29
归档原因:提案范围过大,已拆分为 5 个独立提案
已完成任务(止血类)
本提案中已完成的紧急修复任务:
1. 限流覆盖真实 API 路由组 ✅
- 调整限流挂载位置,覆盖
/api/admin、/api/h5、/api/c/v1 - 明确排除
/api/callback、/health、/ready
2. 短信验证码未配置不崩溃 ✅
- 短信客户端增加初始化流程(基于配置)
- 验证码服务在 smsClient 为空时返回
CodeServiceUnavailable(503) - 补充相关测试用例
3. 部分 Service 层错误统一 ✅
- 已完成 4 个文件:
verification/service.go(10 处)personal_customer/service.go(11 处)auth/service.go(4 处)device_import/service.go(2 处)
拆分后的新提案
剩余任务已拆分为以下独立提案:
| 提案 | 目录 | 优先级 | 预估工作量 |
|---|---|---|---|
| Service 层错误统一 - 核心业务 | service-error-unify-core |
🔴 高 | 4.5h |
| Service 层错误统一 - 支持模块 | service-error-unify-support |
🟡 中 | 7h |
| Handler 层参数校验安全加固 | handler-validation-security |
🟡 中 | 5h |
| OpenAPI 文档契约对齐 | openapi-contract-alignment |
🟡 中 | 4h |
| 代码清理和规范文档更新 | code-cleanup-docs-update |
🟢 低 | 3.5h |
执行顺序建议
提案 1 (核心业务) → 提案 2 (支持模块) → 提案 3 (Handler 层) → 提案 4 (OpenAPI) → 提案 5 (清理)
参考文档
- 原提案:
proposal.md - 任务清单:
tasks.md - 后续建议:
NEXT_STEPS.md