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_card
import (
"context"
"fmt"
"time"
"github.com/break/junhong_cmp_fiber/internal/model"
@@ -45,7 +44,7 @@ func (s *Service) AllocateCardsPreview(ctx context.Context, enterpriseID uint, r
var iotCards []model.IotCard
if err := s.db.WithContext(ctx).Where("iccid IN ?", req.ICCIDs).Find(&iotCards).Error; err != nil {
return nil, fmt.Errorf("查询卡信息失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "查询卡信息失败")
}
cardMap := make(map[string]*model.IotCard)
@@ -141,7 +140,7 @@ func (s *Service) AllocateCards(ctx context.Context, enterpriseID uint, req *dto
existingAuths, err := s.enterpriseCardAuthStore.GetActiveAuthsByCardIDs(ctx, enterpriseID, cardIDsToAllocate)
if err != nil {
return nil, fmt.Errorf("查询已有授权失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "查询已有授权失败")
}
now := time.Now()
@@ -163,7 +162,7 @@ func (s *Service) AllocateCards(ctx context.Context, enterpriseID uint, req *dto
if len(auths) > 0 {
if err := s.enterpriseCardAuthStore.BatchCreate(ctx, auths); err != nil {
return nil, fmt.Errorf("创建授权记录失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "创建授权记录失败")
}
}
@@ -184,7 +183,7 @@ func (s *Service) RecallCards(ctx context.Context, enterpriseID uint, req *dto.R
var iotCards []model.IotCard
if err := s.db.WithContext(ctx).Where("iccid IN ?", req.ICCIDs).Find(&iotCards).Error; err != nil {
return nil, fmt.Errorf("查询卡信息失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "查询卡信息失败")
}
cardMap := make(map[string]*model.IotCard)
@@ -198,7 +197,7 @@ func (s *Service) RecallCards(ctx context.Context, enterpriseID uint, req *dto.R
existingAuths, err := s.enterpriseCardAuthStore.GetActiveAuthsByCardIDs(ctx, enterpriseID, cardIDs)
if err != nil {
return nil, fmt.Errorf("查询已有授权失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "查询已有授权失败")
}
resp := &dto.RecallCardsResp{
@@ -228,7 +227,7 @@ func (s *Service) RecallCards(ctx context.Context, enterpriseID uint, req *dto.R
if len(cardIDsToRecall) > 0 {
if err := s.enterpriseCardAuthStore.BatchUpdateStatus(ctx, enterpriseID, cardIDsToRecall, 0); err != nil {
return nil, fmt.Errorf("回收授权失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "回收授权失败")
}
}
@@ -245,7 +244,7 @@ func (s *Service) ListCards(ctx context.Context, enterpriseID uint, req *dto.Ent
cardIDs, err := s.enterpriseCardAuthStore.ListCardIDsByEnterprise(ctx, enterpriseID)
if err != nil {
return nil, fmt.Errorf("查询授权卡ID失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "查询授权卡ID失败")
}
if len(cardIDs) == 0 {
@@ -280,13 +279,13 @@ func (s *Service) ListCards(ctx context.Context, enterpriseID uint, req *dto.Ent
var total int64
if err := query.Count(&total).Error; err != nil {
return nil, fmt.Errorf("统计卡数量失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "统计卡数量失败")
}
var cards []model.IotCard
offset := (page - 1) * pageSize
if err := query.Offset(offset).Limit(pageSize).Order("created_at DESC").Find(&cards).Error; err != nil {
return nil, fmt.Errorf("查询卡列表失败: %w", err)
return nil, errors.Wrap(errors.CodeInternalError, err, "查询卡列表失败")
}
items := make([]dto.EnterpriseCardItem, 0, len(cards))