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

@@ -50,7 +50,7 @@ func (s *Service) Create(ctx context.Context, req *dto.CreateRoleRequest) (*mode
}
if err := s.roleStore.Create(ctx, role); err != nil {
return nil, fmt.Errorf("创建角色失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "创建角色失败")
}
return role, nil
@@ -63,7 +63,7 @@ func (s *Service) Get(ctx context.Context, id uint) (*model.Role, error) {
if err == gorm.ErrRecordNotFound {
return nil, errors.New(errors.CodeRoleNotFound, "角色不存在")
}
return nil, fmt.Errorf("获取角色失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取角色失败")
}
return role, nil
}
@@ -82,7 +82,7 @@ func (s *Service) Update(ctx context.Context, id uint, req *dto.UpdateRoleReques
if err == gorm.ErrRecordNotFound {
return nil, errors.New(errors.CodeRoleNotFound, "角色不存在")
}
return nil, fmt.Errorf("获取角色失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取角色失败")
}
// 更新字段
@@ -99,7 +99,7 @@ func (s *Service) Update(ctx context.Context, id uint, req *dto.UpdateRoleReques
role.Updater = currentUserID
if err := s.roleStore.Update(ctx, role); err != nil {
return nil, fmt.Errorf("更新角色失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "更新角色失败")
}
return role, nil
@@ -113,11 +113,11 @@ func (s *Service) Delete(ctx context.Context, id uint) error {
if err == gorm.ErrRecordNotFound {
return errors.New(errors.CodeRoleNotFound, "角色不存在")
}
return fmt.Errorf("获取角色失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "获取角色失败")
}
if err := s.roleStore.Delete(ctx, id); err != nil {
return fmt.Errorf("删除角色失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "删除角色失败")
}
return nil
@@ -163,12 +163,12 @@ func (s *Service) AssignPermissions(ctx context.Context, roleID uint, permIDs []
if err == gorm.ErrRecordNotFound {
return nil, errors.New(errors.CodeRoleNotFound, "角色不存在")
}
return nil, fmt.Errorf("获取角色失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取角色失败")
}
permissions, err := s.permissionStore.GetByIDs(ctx, permIDs)
if err != nil {
return nil, fmt.Errorf("获取权限失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取权限失败")
}
if len(permissions) != len(permIDs) {
@@ -200,7 +200,7 @@ func (s *Service) AssignPermissions(ctx context.Context, roleID uint, permIDs []
Status: constants.StatusEnabled,
}
if err := s.rolePermissionStore.Create(ctx, rp); err != nil {
return nil, fmt.Errorf("创建角色-权限关联失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "创建角色-权限关联失败")
}
rps = append(rps, rp)
}
@@ -216,13 +216,13 @@ func (s *Service) GetPermissions(ctx context.Context, roleID uint) ([]*model.Per
if err == gorm.ErrRecordNotFound {
return nil, errors.New(errors.CodeRoleNotFound, "角色不存在")
}
return nil, fmt.Errorf("获取角色失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取角色失败")
}
// 获取权限 ID 列表
permIDs, err := s.rolePermissionStore.GetPermIDsByRoleID(ctx, roleID)
if err != nil {
return nil, fmt.Errorf("获取角色权限 ID 失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "获取角色权限 ID 失败")
}
if len(permIDs) == 0 {
@@ -240,11 +240,11 @@ func (s *Service) RemovePermission(ctx context.Context, roleID, permID uint) err
if err == gorm.ErrRecordNotFound {
return errors.New(errors.CodeRoleNotFound, "角色不存在")
}
return fmt.Errorf("获取角色失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "获取角色失败")
}
if err := s.rolePermissionStore.Delete(ctx, roleID, permID); err != nil {
return fmt.Errorf("删除角色-权限关联失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "删除角色-权限关联失败")
}
return nil
@@ -262,14 +262,14 @@ func (s *Service) UpdateStatus(ctx context.Context, id uint, status int) error {
if err == gorm.ErrRecordNotFound {
return errors.New(errors.CodeRoleNotFound, "角色不存在")
}
return fmt.Errorf("获取角色失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "获取角色失败")
}
role.Status = status
role.Updater = currentUserID
if err := s.roleStore.Update(ctx, role); err != nil {
return fmt.Errorf("更新角色状态失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "更新角色状态失败")
}
return nil