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

@@ -8,6 +8,7 @@ import (
"github.com/break/junhong_cmp_fiber/internal/task"
"github.com/break/junhong_cmp_fiber/pkg/constants"
"github.com/break/junhong_cmp_fiber/pkg/errors"
"github.com/break/junhong_cmp_fiber/pkg/queue"
"github.com/bytedance/sonic"
"github.com/hibiken/asynq"
@@ -43,7 +44,7 @@ func (s *Service) SyncSIMStatus(ctx context.Context, iccids []string, forceSync
zap.Int("iccid_count", len(iccids)),
zap.Bool("force_sync", forceSync),
zap.Error(err))
return fmt.Errorf("序列化 SIM 状态同步任务载荷失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "序列化 SIM 状态同步任务载荷失败")
}
// 提交任务到队列(高优先级)
@@ -59,7 +60,7 @@ func (s *Service) SyncSIMStatus(ctx context.Context, iccids []string, forceSync
s.logger.Error("提交 SIM 状态同步任务失败",
zap.Int("iccid_count", len(iccids)),
zap.Error(err))
return fmt.Errorf("提交 SIM 状态同步任务失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "提交 SIM 状态同步任务失败")
}
s.logger.Info("SIM 状态同步任务已提交",
@@ -92,7 +93,7 @@ func (s *Service) SyncData(ctx context.Context, syncType string, startDate strin
zap.String("start_date", startDate),
zap.String("end_date", endDate),
zap.Error(err))
return fmt.Errorf("序列化数据同步任务载荷失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "序列化数据同步任务载荷失败")
}
// 提交任务到队列(默认优先级)
@@ -108,7 +109,7 @@ func (s *Service) SyncData(ctx context.Context, syncType string, startDate strin
s.logger.Error("提交数据同步任务失败",
zap.String("sync_type", syncType),
zap.Error(err))
return fmt.Errorf("提交数据同步任务失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "提交数据同步任务失败")
}
s.logger.Info("数据同步任务已提交",