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

@@ -2,7 +2,6 @@ package enterprise
import (
"context"
"fmt"
"github.com/break/junhong_cmp_fiber/internal/model"
"github.com/break/junhong_cmp_fiber/internal/model/dto"
@@ -58,7 +57,7 @@ func (s *Service) Create(ctx context.Context, req *dto.CreateEnterpriseReq) (*dt
hashedPassword, err := bcrypt.GenerateFromPassword([]byte(req.Password), bcrypt.DefaultCost)
if err != nil {
return nil, fmt.Errorf("密码加密失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "密码加密失败")
}
var enterprise *model.Enterprise
@@ -83,7 +82,7 @@ func (s *Service) Create(ctx context.Context, req *dto.CreateEnterpriseReq) (*dt
enterprise.Updater = currentUserID
if err := tx.WithContext(ctx).Create(enterprise).Error; err != nil {
return fmt.Errorf("创建企业失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "创建企业失败")
}
account = &model.Account{
@@ -98,7 +97,7 @@ func (s *Service) Create(ctx context.Context, req *dto.CreateEnterpriseReq) (*dt
account.Updater = currentUserID
if err := tx.WithContext(ctx).Create(account).Error; err != nil {
return fmt.Errorf("创建企业账号失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "创建企业账号失败")
}
return nil
@@ -215,7 +214,7 @@ func (s *Service) UpdateStatus(ctx context.Context, id uint, status int) error {
enterprise.Status = status
enterprise.Updater = currentUserID
if err := tx.WithContext(ctx).Save(enterprise).Error; err != nil {
return fmt.Errorf("更新企业状态失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "更新企业状态失败")
}
if err := tx.WithContext(ctx).Model(&model.Account{}).
@@ -224,7 +223,7 @@ func (s *Service) UpdateStatus(ctx context.Context, id uint, status int) error {
"status": status,
"updater": currentUserID,
}).Error; err != nil {
return fmt.Errorf("同步更新企业账号状态失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "同步更新企业账号状态失败")
}
return nil
@@ -244,7 +243,7 @@ func (s *Service) UpdatePassword(ctx context.Context, id uint, password string)
hashedPassword, err := bcrypt.GenerateFromPassword([]byte(password), bcrypt.DefaultCost)
if err != nil {
return fmt.Errorf("密码加密失败: %w", err)
return errors.Wrap(errors.CodeInternalError, err, "密码加密失败")
}
return s.db.WithContext(ctx).Model(&model.Account{}).
@@ -291,7 +290,7 @@ func (s *Service) List(ctx context.Context, req *dto.EnterpriseListReq) (*dto.En
enterprises, total, err := s.enterpriseStore.List(ctx, opts, filters)
if err != nil {
return nil, fmt.Errorf("查询企业列表失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "查询企业列表失败")
}
enterpriseIDs := make([]uint, 0, len(enterprises))