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

@@ -58,7 +58,7 @@ func (s *Service) Create(ctx context.Context, req *dto.CreatePackageRequest) (*d
if err == gorm.ErrRecordNotFound {
return nil, errors.New(errors.CodeNotFound, "套餐系列不存在")
}
return nil, fmt.Errorf("获取套餐系列失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取套餐系列失败")
}
seriesName = &series.SeriesName
}
@@ -96,7 +96,7 @@ func (s *Service) Create(ctx context.Context, req *dto.CreatePackageRequest) (*d
pkg.Creator = currentUserID
if err := s.packageStore.Create(ctx, pkg); err != nil {
return nil, fmt.Errorf("创建套餐失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "创建套餐失败")
}
resp := s.toResponse(ctx, pkg)
@@ -110,7 +110,7 @@ func (s *Service) Get(ctx context.Context, id uint) (*dto.PackageResponse, error
if err == gorm.ErrRecordNotFound {
return nil, errors.New(errors.CodeNotFound, "套餐不存在")
}
return nil, fmt.Errorf("获取套餐失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取套餐失败")
}
resp := s.toResponse(ctx, pkg)
@@ -135,7 +135,7 @@ func (s *Service) Update(ctx context.Context, id uint, req *dto.UpdatePackageReq
if err == gorm.ErrRecordNotFound {
return nil, errors.New(errors.CodeNotFound, "套餐不存在")
}
return nil, fmt.Errorf("获取套餐失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取套餐失败")
}
var seriesName *string
@@ -145,7 +145,7 @@ func (s *Service) Update(ctx context.Context, id uint, req *dto.UpdatePackageReq
if err == gorm.ErrRecordNotFound {
return nil, errors.New(errors.CodeNotFound, "套餐系列不存在")
}
return nil, fmt.Errorf("获取套餐系列失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取套餐系列失败")
}
pkg.SeriesID = *req.SeriesID
seriesName = &series.SeriesName
@@ -190,7 +190,7 @@ func (s *Service) Update(ctx context.Context, id uint, req *dto.UpdatePackageReq
pkg.Updater = currentUserID
if err := s.packageStore.Update(ctx, pkg); err != nil {
return nil, fmt.Errorf("更新套餐失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "更新套餐失败")
}
resp := s.toResponse(ctx, pkg)
@@ -204,11 +204,11 @@ func (s *Service) Delete(ctx context.Context, id uint) error {
if err == gorm.ErrRecordNotFound {
return errors.New(errors.CodeNotFound, "套餐不存在")
}
return fmt.Errorf("获取套餐失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "获取套餐失败")
}
if err := s.packageStore.Delete(ctx, id); err != nil {
return fmt.Errorf("删除套餐失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "删除套餐失败")
}
return nil
@@ -246,7 +246,7 @@ func (s *Service) List(ctx context.Context, req *dto.PackageListRequest) ([]*dto
packages, total, err := s.packageStore.List(ctx, opts, filters)
if err != nil {
return nil, 0, fmt.Errorf("查询套餐列表失败: %w", err)
return nil, 0, errors.Wrap(errors.CodeInternalError, err, "查询套餐列表失败")
}
// 收集所有唯一的 series_id
@@ -266,7 +266,7 @@ func (s *Service) List(ctx context.Context, req *dto.PackageListRequest) ([]*dto
}
seriesList, err := s.packageSeriesStore.GetByIDs(ctx, seriesIDs)
if err != nil {
return nil, 0, fmt.Errorf("批量查询套餐系列失败: %w", err)
return nil, 0, errors.Wrap(errors.CodeInternalError, err, "批量查询套餐系列失败")
}
for _, series := range seriesList {
seriesMap[series.ID] = series.SeriesName
@@ -299,7 +299,7 @@ func (s *Service) UpdateStatus(ctx context.Context, id uint, status int) error {
if err == gorm.ErrRecordNotFound {
return errors.New(errors.CodeNotFound, "套餐不存在")
}
return fmt.Errorf("获取套餐失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "获取套餐失败")
}
pkg.Status = status
@@ -310,7 +310,7 @@ func (s *Service) UpdateStatus(ctx context.Context, id uint, status int) error {
}
if err := s.packageStore.Update(ctx, pkg); err != nil {
return fmt.Errorf("更新套餐状态失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "更新套餐状态失败")
}
return nil
@@ -327,7 +327,7 @@ func (s *Service) UpdateShelfStatus(ctx context.Context, id uint, shelfStatus in
if err == gorm.ErrRecordNotFound {
return errors.New(errors.CodeNotFound, "套餐不存在")
}
return fmt.Errorf("获取套餐失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "获取套餐失败")
}
if shelfStatus == 1 && pkg.Status == constants.StatusDisabled {
@@ -338,7 +338,7 @@ func (s *Service) UpdateShelfStatus(ctx context.Context, id uint, shelfStatus in
pkg.Updater = currentUserID
if err := s.packageStore.Update(ctx, pkg); err != nil {
return fmt.Errorf("更新套餐上架状态失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "更新套餐上架状态失败")
}
return nil