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:
@@ -23,7 +23,7 @@ func NewPermissionHandler(service *permissionService.Service) *PermissionHandler
|
||||
}
|
||||
|
||||
// Create 创建权限
|
||||
// POST /api/v1/permissions
|
||||
// POST /api/admin/permissions
|
||||
func (h *PermissionHandler) Create(c *fiber.Ctx) error {
|
||||
var req dto.CreatePermissionRequest
|
||||
if err := c.BodyParser(&req); err != nil {
|
||||
@@ -39,7 +39,7 @@ func (h *PermissionHandler) Create(c *fiber.Ctx) error {
|
||||
}
|
||||
|
||||
// Get 获取权限详情
|
||||
// GET /api/v1/permissions/:id
|
||||
// GET /api/admin/permissions/:id
|
||||
func (h *PermissionHandler) Get(c *fiber.Ctx) error {
|
||||
id, err := strconv.ParseUint(c.Params("id"), 10, 64)
|
||||
if err != nil {
|
||||
@@ -55,7 +55,7 @@ func (h *PermissionHandler) Get(c *fiber.Ctx) error {
|
||||
}
|
||||
|
||||
// Update 更新权限
|
||||
// PUT /api/v1/permissions/:id
|
||||
// PUT /api/admin/permissions/:id
|
||||
func (h *PermissionHandler) Update(c *fiber.Ctx) error {
|
||||
id, err := strconv.ParseUint(c.Params("id"), 10, 64)
|
||||
if err != nil {
|
||||
@@ -76,7 +76,7 @@ func (h *PermissionHandler) Update(c *fiber.Ctx) error {
|
||||
}
|
||||
|
||||
// Delete 删除权限
|
||||
// DELETE /api/v1/permissions/:id
|
||||
// DELETE /api/admin/permissions/:id
|
||||
func (h *PermissionHandler) Delete(c *fiber.Ctx) error {
|
||||
id, err := strconv.ParseUint(c.Params("id"), 10, 64)
|
||||
if err != nil {
|
||||
@@ -91,7 +91,7 @@ func (h *PermissionHandler) Delete(c *fiber.Ctx) error {
|
||||
}
|
||||
|
||||
// List 查询权限列表
|
||||
// GET /api/v1/permissions
|
||||
// GET /api/admin/permissions
|
||||
func (h *PermissionHandler) List(c *fiber.Ctx) error {
|
||||
var req dto.PermissionListRequest
|
||||
if err := c.QueryParser(&req); err != nil {
|
||||
@@ -107,7 +107,7 @@ func (h *PermissionHandler) List(c *fiber.Ctx) error {
|
||||
}
|
||||
|
||||
// GetTree 获取权限树
|
||||
// GET /api/v1/permissions/tree
|
||||
// GET /api/admin/permissions/tree
|
||||
func (h *PermissionHandler) GetTree(c *fiber.Ctx) error {
|
||||
var availableForRoleType *int
|
||||
if roleTypeStr := c.Query("available_for_role_type"); roleTypeStr != "" {
|
||||
|
||||
Reference in New Issue
Block a user