完善 API 文档生成规范:统一路由注册和 OpenAPI 文档自动生成
All checks were successful
构建并部署到测试环境(无 SSH) / build-and-deploy (push) Successful in 4m32s

主要改进:
1. 新增 docs/api-documentation-guide.md 详细文档指南
2. 在 AGENTS.md 中添加路由注册规范章节
3. 更新 README.md 文档目录结构

路由注册改进:
- 统一使用 Register() 函数注册路由并自动生成文档
- 所有接口必须指定 RouteSpec(Summary, Tags, Input, Output, Auth)
- 修复 docs.go 和 gendocs/main.go 使用 RegisterRoutesWithDoc 统一注册

DTO 规范更新:
- shop_dto.go 和 shop_account_dto.go 补充完整的 description 标签
- 所有枚举字段必须列出可能值和中文说明

文档生成优化:
- admin-openapi.yaml 自动生成更新
- 健康检查和任务管理接口加入文档
- H5 认证接口完整文档化

规范文档管理:
- 添加规范文档管理流程说明
- 详细文档放在 docs/ 目录
- AGENTS.md 只保留核心规则和引导链接
This commit is contained in:
2026-01-21 10:20:52 +08:00
parent 291c3d1b09
commit 573ef28237
12 changed files with 1760 additions and 59 deletions

View File

@@ -1,21 +1,33 @@
package routes
import (
"github.com/break/junhong_cmp_fiber/pkg/response"
"github.com/gofiber/fiber/v2"
"github.com/break/junhong_cmp_fiber/internal/model"
"github.com/break/junhong_cmp_fiber/pkg/openapi"
"github.com/break/junhong_cmp_fiber/pkg/response"
)
// registerTaskRoutes 注册任务相关路由
// 用于异步任务状态查询等
func registerTaskRoutes(api fiber.Router) {
tasks := api.Group("/tasks")
type TaskStatusResponse struct {
ID string `json:"id" description:"任务ID"`
Status string `json:"status" description:"任务状态 (pending:待处理, running:执行中, completed:已完成, failed:失败)"`
}
// 获取任务状态(占位实现)
tasks.Get("/:id", func(c *fiber.Ctx) error {
func registerTaskRoutes(api fiber.Router, doc *openapi.Generator, basePath string) {
tasks := api.Group("/tasks")
groupPath := basePath + "/tasks"
Register(tasks, doc, groupPath, "GET", "/:id", func(c *fiber.Ctx) error {
taskID := c.Params("id")
return response.Success(c, fiber.Map{
"id": taskID,
"status": "pending",
})
}, RouteSpec{
Summary: "查询任务状态",
Tags: []string{"任务管理"},
Input: new(model.IDReq),
Output: new(TaskStatusResponse),
Auth: true,
})
}