feat: OpenAPI 契约对齐与框架优化
All checks were successful
构建并部署到测试环境(无 SSH) / build-and-deploy (push) Successful in 5m45s
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:
@@ -2,7 +2,6 @@ package shop_account
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"github.com/break/junhong_cmp_fiber/internal/model"
|
||||
"github.com/break/junhong_cmp_fiber/internal/model/dto"
|
||||
@@ -64,7 +63,7 @@ func (s *Service) List(ctx context.Context, req *dto.ShopAccountListRequest) ([]
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
return nil, 0, fmt.Errorf("查询代理商账号列表失败: %w", err)
|
||||
return nil, 0, errors.Wrap(errors.CodeInternalError, err, "查询代理商账号列表失败")
|
||||
}
|
||||
|
||||
shopMap := make(map[uint]string)
|
||||
@@ -113,7 +112,7 @@ func (s *Service) Create(ctx context.Context, req *dto.CreateShopAccountRequest)
|
||||
if err == gorm.ErrRecordNotFound {
|
||||
return nil, errors.New(errors.CodeShopNotFound, "店铺不存在")
|
||||
}
|
||||
return nil, fmt.Errorf("获取店铺失败: %w", err)
|
||||
return nil, errors.Wrap(errors.CodeInternalError, err, "获取店铺失败")
|
||||
}
|
||||
|
||||
existing, err := s.accountStore.GetByUsername(ctx, req.Username)
|
||||
@@ -128,7 +127,7 @@ func (s *Service) Create(ctx context.Context, req *dto.CreateShopAccountRequest)
|
||||
|
||||
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, "密码哈希失败")
|
||||
}
|
||||
|
||||
account := &model.Account{
|
||||
@@ -143,7 +142,7 @@ func (s *Service) Create(ctx context.Context, req *dto.CreateShopAccountRequest)
|
||||
account.Updater = currentUserID
|
||||
|
||||
if err := s.accountStore.Create(ctx, account); err != nil {
|
||||
return nil, fmt.Errorf("创建代理商账号失败: %w", err)
|
||||
return nil, errors.Wrap(errors.CodeInternalError, err, "创建代理商账号失败")
|
||||
}
|
||||
|
||||
return &dto.ShopAccountResponse{
|
||||
@@ -170,7 +169,7 @@ func (s *Service) Update(ctx context.Context, id uint, req *dto.UpdateShopAccoun
|
||||
if err == gorm.ErrRecordNotFound {
|
||||
return nil, errors.New(errors.CodeAccountNotFound, "账号不存在")
|
||||
}
|
||||
return nil, fmt.Errorf("获取账号失败: %w", err)
|
||||
return nil, errors.Wrap(errors.CodeInternalError, err, "获取账号失败")
|
||||
}
|
||||
|
||||
if account.UserType != constants.UserTypeAgent {
|
||||
@@ -186,7 +185,7 @@ func (s *Service) Update(ctx context.Context, id uint, req *dto.UpdateShopAccoun
|
||||
account.Updater = currentUserID
|
||||
|
||||
if err := s.accountStore.Update(ctx, account); err != nil {
|
||||
return nil, fmt.Errorf("更新代理商账号失败: %w", err)
|
||||
return nil, errors.Wrap(errors.CodeInternalError, err, "更新代理商账号失败")
|
||||
}
|
||||
|
||||
var shopName string
|
||||
@@ -221,7 +220,7 @@ func (s *Service) UpdatePassword(ctx context.Context, id uint, req *dto.UpdateSh
|
||||
if err == gorm.ErrRecordNotFound {
|
||||
return errors.New(errors.CodeAccountNotFound, "账号不存在")
|
||||
}
|
||||
return fmt.Errorf("获取账号失败: %w", err)
|
||||
return errors.Wrap(errors.CodeInternalError, err, "获取账号失败")
|
||||
}
|
||||
|
||||
if account.UserType != constants.UserTypeAgent {
|
||||
@@ -230,11 +229,11 @@ func (s *Service) UpdatePassword(ctx context.Context, id uint, req *dto.UpdateSh
|
||||
|
||||
hashedPassword, err := bcrypt.GenerateFromPassword([]byte(req.NewPassword), bcrypt.DefaultCost)
|
||||
if err != nil {
|
||||
return fmt.Errorf("密码哈希失败: %w", err)
|
||||
return errors.Wrap(errors.CodeInternalError, err, "密码哈希失败")
|
||||
}
|
||||
|
||||
if err := s.accountStore.UpdatePassword(ctx, id, string(hashedPassword), currentUserID); err != nil {
|
||||
return fmt.Errorf("更新密码失败: %w", err)
|
||||
return errors.Wrap(errors.CodeInternalError, err, "更新密码失败")
|
||||
}
|
||||
|
||||
return nil
|
||||
@@ -251,7 +250,7 @@ func (s *Service) UpdateStatus(ctx context.Context, id uint, req *dto.UpdateShop
|
||||
if err == gorm.ErrRecordNotFound {
|
||||
return errors.New(errors.CodeAccountNotFound, "账号不存在")
|
||||
}
|
||||
return fmt.Errorf("获取账号失败: %w", err)
|
||||
return errors.Wrap(errors.CodeInternalError, err, "获取账号失败")
|
||||
}
|
||||
|
||||
if account.UserType != constants.UserTypeAgent {
|
||||
@@ -259,7 +258,7 @@ func (s *Service) UpdateStatus(ctx context.Context, id uint, req *dto.UpdateShop
|
||||
}
|
||||
|
||||
if err := s.accountStore.UpdateStatus(ctx, id, req.Status, currentUserID); err != nil {
|
||||
return fmt.Errorf("更新账号状态失败: %w", err)
|
||||
return errors.Wrap(errors.CodeInternalError, err, "更新账号状态失败")
|
||||
}
|
||||
|
||||
return nil
|
||||
|
||||
Reference in New Issue
Block a user