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

@@ -5,8 +5,10 @@ import (
"github.com/go-playground/validator/v10"
"github.com/gofiber/fiber/v2"
"go.uber.org/zap"
"github.com/break/junhong_cmp_fiber/pkg/errors"
"github.com/break/junhong_cmp_fiber/pkg/logger"
"github.com/break/junhong_cmp_fiber/pkg/response"
"github.com/break/junhong_cmp_fiber/internal/model/dto"
@@ -28,7 +30,7 @@ func NewRoleHandler(service *roleService.Service, validator *validator.Validate)
}
// Create 创建角色
// POST /api/v1/roles
// POST /api/admin/roles
func (h *RoleHandler) Create(c *fiber.Ctx) error {
var req dto.CreateRoleRequest
if err := c.BodyParser(&req); err != nil {
@@ -36,7 +38,12 @@ func (h *RoleHandler) Create(c *fiber.Ctx) error {
}
if err := h.validator.Struct(&req); err != nil {
return errors.New(errors.CodeInvalidParam, "参数验证失败: "+err.Error())
logger.GetAppLogger().Warn("参数验证失败",
zap.String("path", c.Path()),
zap.String("method", c.Method()),
zap.Error(err),
)
return errors.New(errors.CodeInvalidParam)
}
role, err := h.service.Create(c.UserContext(), &req)
@@ -48,7 +55,7 @@ func (h *RoleHandler) Create(c *fiber.Ctx) error {
}
// Get 获取角色详情
// GET /api/v1/roles/:id
// GET /api/admin/roles/:id
func (h *RoleHandler) Get(c *fiber.Ctx) error {
id, err := strconv.ParseUint(c.Params("id"), 10, 64)
if err != nil {
@@ -64,7 +71,7 @@ func (h *RoleHandler) Get(c *fiber.Ctx) error {
}
// Update 更新角色
// PUT /api/v1/roles/:id
// PUT /api/admin/roles/:id
func (h *RoleHandler) Update(c *fiber.Ctx) error {
id, err := strconv.ParseUint(c.Params("id"), 10, 64)
if err != nil {
@@ -77,7 +84,12 @@ func (h *RoleHandler) Update(c *fiber.Ctx) error {
}
if err := h.validator.Struct(&req); err != nil {
return errors.New(errors.CodeInvalidParam, "参数验证失败: "+err.Error())
logger.GetAppLogger().Warn("参数验证失败",
zap.String("path", c.Path()),
zap.String("method", c.Method()),
zap.Error(err),
)
return errors.New(errors.CodeInvalidParam)
}
role, err := h.service.Update(c.UserContext(), uint(id), &req)
@@ -89,7 +101,7 @@ func (h *RoleHandler) Update(c *fiber.Ctx) error {
}
// Delete 删除角色
// DELETE /api/v1/roles/:id
// DELETE /api/admin/roles/:id
func (h *RoleHandler) Delete(c *fiber.Ctx) error {
id, err := strconv.ParseUint(c.Params("id"), 10, 64)
if err != nil {
@@ -104,7 +116,7 @@ func (h *RoleHandler) Delete(c *fiber.Ctx) error {
}
// List 查询角色列表
// GET /api/v1/roles
// GET /api/admin/roles
func (h *RoleHandler) List(c *fiber.Ctx) error {
var req dto.RoleListRequest
if err := c.QueryParser(&req); err != nil {
@@ -120,7 +132,7 @@ func (h *RoleHandler) List(c *fiber.Ctx) error {
}
// AssignPermissions 为角色分配权限
// POST /api/v1/roles/:id/permissions
// POST /api/admin/roles/:id/permissions
func (h *RoleHandler) AssignPermissions(c *fiber.Ctx) error {
id, err := strconv.ParseUint(c.Params("id"), 10, 64)
if err != nil {
@@ -133,7 +145,12 @@ func (h *RoleHandler) AssignPermissions(c *fiber.Ctx) error {
}
if err := h.validator.Struct(&req); err != nil {
return errors.New(errors.CodeInvalidParam, "参数验证失败: "+err.Error())
logger.GetAppLogger().Warn("参数验证失败",
zap.String("path", c.Path()),
zap.String("method", c.Method()),
zap.Error(err),
)
return errors.New(errors.CodeInvalidParam)
}
rps, err := h.service.AssignPermissions(c.UserContext(), uint(id), req.PermIDs)
@@ -145,7 +162,7 @@ func (h *RoleHandler) AssignPermissions(c *fiber.Ctx) error {
}
// GetPermissions 获取角色的所有权限
// GET /api/v1/roles/:id/permissions
// GET /api/admin/roles/:id/permissions
func (h *RoleHandler) GetPermissions(c *fiber.Ctx) error {
id, err := strconv.ParseUint(c.Params("id"), 10, 64)
if err != nil {
@@ -161,7 +178,7 @@ func (h *RoleHandler) GetPermissions(c *fiber.Ctx) error {
}
// RemovePermission 移除角色的权限
// DELETE /api/v1/roles/:role_id/permissions/:perm_id
// DELETE /api/admin/roles/:role_id/permissions/:perm_id
func (h *RoleHandler) RemovePermission(c *fiber.Ctx) error {
roleID, err := strconv.ParseUint(c.Params("role_id"), 10, 64)
if err != nil {
@@ -181,7 +198,7 @@ func (h *RoleHandler) RemovePermission(c *fiber.Ctx) error {
}
// UpdateStatus 更新角色状态
// PUT /api/v1/roles/:id/status
// PUT /api/admin/roles/:id/status
func (h *RoleHandler) UpdateStatus(c *fiber.Ctx) error {
id, err := strconv.ParseUint(c.Params("id"), 10, 64)
if err != nil {
@@ -194,7 +211,12 @@ func (h *RoleHandler) UpdateStatus(c *fiber.Ctx) error {
}
if err := h.validator.Struct(&req); err != nil {
return errors.New(errors.CodeInvalidParam, "参数验证失败: "+err.Error())
logger.GetAppLogger().Warn("参数验证失败",
zap.String("path", c.Path()),
zap.String("method", c.Method()),
zap.Error(err),
)
return errors.New(errors.CodeInvalidParam)
}
if err := h.service.UpdateStatus(c.UserContext(), uint(id), req.Status); err != nil {