完善 API 文档生成规范：统一路由注册和 OpenAPI 文档自动生成

主要改进：
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 只保留核心规则和引导链接

internal/routes/health.go

@@ -1,25 +1,40 @@
 package routes
 
 import (
-	"github.com/break/junhong_cmp_fiber/pkg/response"
 	"github.com/gofiber/fiber/v2"
+
+	"github.com/break/junhong_cmp_fiber/pkg/openapi"
+	"github.com/break/junhong_cmp_fiber/pkg/response"
 )
 
-// registerHealthRoutes 注册健康检查路由
-// 不需要认证，用于负载均衡器和监控系统
-func registerHealthRoutes(app *fiber.App) {
-	// 健康检查
-	app.Get("/health", func(c *fiber.Ctx) error {
+type HealthResponse struct {
+	Status  string `json:"status" description:"健康状态"`
+	Service string `json:"service,omitempty" description:"服务名称"`
+}
+
+func registerHealthRoutes(app *fiber.App, doc *openapi.Generator) {
+	Register(app, doc, "", "GET", "/health", func(c *fiber.Ctx) error {
 		return response.Success(c, fiber.Map{
 			"status":  "healthy",
 			"service": "junhong_cmp_fiber",
 		})
+	}, RouteSpec{
+		Summary: "健康检查",
+		Tags:    []string{"系统"},
+		Input:   nil,
+		Output:  new(HealthResponse),
+		Auth:    false,
 	})
 
-	// 就绪检查
-	app.Get("/ready", func(c *fiber.Ctx) error {
+	Register(app, doc, "", "GET", "/ready", func(c *fiber.Ctx) error {
 		return response.Success(c, fiber.Map{
 			"status": "ready",
 		})
+	}, RouteSpec{
+		Summary: "就绪检查",
+		Tags:    []string{"系统"},
+		Input:   nil,
+		Output:  new(HealthResponse),
+		Auth:    false,
 	})
 }

internal/routes/routes.go

@@ -4,24 +4,30 @@ import (
 	"github.com/gofiber/fiber/v2"
 
 	"github.com/break/junhong_cmp_fiber/internal/bootstrap"
+	"github.com/break/junhong_cmp_fiber/pkg/openapi"
 )
 
 // RegisterRoutes 路由注册总入口
 // 按业务模块调用各自的路由注册函数
 func RegisterRoutes(app *fiber.App, handlers *bootstrap.Handlers, middlewares *bootstrap.Middlewares) {
+	RegisterRoutesWithDoc(app, handlers, middlewares, nil)
+}
+
+// RegisterRoutesWithDoc 路由注册总入口（支持文档生成）
+func RegisterRoutesWithDoc(app *fiber.App, handlers *bootstrap.Handlers, middlewares *bootstrap.Middlewares, doc *openapi.Generator) {
 	// 1. 全局路由
-	registerHealthRoutes(app)
+	registerHealthRoutes(app, doc)
 
 	// 2. Admin 域 (挂载在 /api/admin)
 	adminGroup := app.Group("/api/admin")
-	RegisterAdminRoutes(adminGroup, handlers, middlewares, nil, "/api/admin")
+	RegisterAdminRoutes(adminGroup, handlers, middlewares, doc, "/api/admin")
 
 	// 任务相关路由 (归属于 Admin 域)
-	registerTaskRoutes(adminGroup)
+	registerTaskRoutes(adminGroup, doc, "/api/admin")
 
 	// 3. H5 域 (挂载在 /api/h5)
 	h5Group := app.Group("/api/h5")
-	RegisterH5Routes(h5Group, handlers, middlewares, nil, "/api/h5")
+	RegisterH5Routes(h5Group, handlers, middlewares, doc, "/api/h5")
 
 	// 4. 个人客户路由 (挂载在 /api/c/v1)
 	RegisterPersonalCustomerRoutes(app, handlers, middlewares.PersonalAuth)

internal/routes/shop.go

@@ -4,20 +4,88 @@ import (
 	"github.com/gofiber/fiber/v2"
 
 	"github.com/break/junhong_cmp_fiber/internal/handler/admin"
+	"github.com/break/junhong_cmp_fiber/internal/model"
 	"github.com/break/junhong_cmp_fiber/pkg/openapi"
 )
 
 func registerShopRoutes(router fiber.Router, handler *admin.ShopHandler, doc *openapi.Generator, basePath string) {
-	router.Get("/shops", handler.List)
-	router.Post("/shops", handler.Create)
-	router.Put("/shops/:id", handler.Update)
-	router.Delete("/shops/:id", handler.Delete)
+	shops := router.Group("/shops")
+	groupPath := basePath + "/shops"
+
+	Register(shops, doc, groupPath, "GET", "", handler.List, RouteSpec{
+		Summary: "店铺列表",
+		Tags:    []string{"店铺管理"},
+		Input:   new(model.ShopListRequest),
+		Output:  new(model.ShopPageResult),
+		Auth:    true,
+	})
+
+	Register(shops, doc, groupPath, "POST", "", handler.Create, RouteSpec{
+		Summary: "创建店铺",
+		Tags:    []string{"店铺管理"},
+		Input:   new(model.CreateShopRequest),
+		Output:  new(model.ShopResponse),
+		Auth:    true,
+	})
+
+	Register(shops, doc, groupPath, "PUT", "/:id", handler.Update, RouteSpec{
+		Summary: "更新店铺",
+		Tags:    []string{"店铺管理"},
+		Input:   new(model.UpdateShopParams),
+		Output:  new(model.ShopResponse),
+		Auth:    true,
+	})
+
+	Register(shops, doc, groupPath, "DELETE", "/:id", handler.Delete, RouteSpec{
+		Summary: "删除店铺",
+		Tags:    []string{"店铺管理"},
+		Input:   new(model.IDReq),
+		Output:  nil,
+		Auth:    true,
+	})
 }
 
 func registerShopAccountRoutes(router fiber.Router, handler *admin.ShopAccountHandler, doc *openapi.Generator, basePath string) {
-	router.Get("/shop-accounts", handler.List)
-	router.Post("/shop-accounts", handler.Create)
-	router.Put("/shop-accounts/:id", handler.Update)
-	router.Put("/shop-accounts/:id/password", handler.UpdatePassword)
-	router.Put("/shop-accounts/:id/status", handler.UpdateStatus)
+	shopAccounts := router.Group("/shop-accounts")
+	groupPath := basePath + "/shop-accounts"
+
+	Register(shopAccounts, doc, groupPath, "GET", "", handler.List, RouteSpec{
+		Summary: "代理账号列表",
+		Tags:    []string{"代理账号管理"},
+		Input:   new(model.ShopAccountListRequest),
+		Output:  new(model.ShopAccountPageResult),
+		Auth:    true,
+	})
+
+	Register(shopAccounts, doc, groupPath, "POST", "", handler.Create, RouteSpec{
+		Summary: "创建代理账号",
+		Tags:    []string{"代理账号管理"},
+		Input:   new(model.CreateShopAccountRequest),
+		Output:  new(model.ShopAccountResponse),
+		Auth:    true,
+	})
+
+	Register(shopAccounts, doc, groupPath, "PUT", "/:id", handler.Update, RouteSpec{
+		Summary: "更新代理账号",
+		Tags:    []string{"代理账号管理"},
+		Input:   new(model.UpdateShopAccountParams),
+		Output:  new(model.ShopAccountResponse),
+		Auth:    true,
+	})
+
+	Register(shopAccounts, doc, groupPath, "PUT", "/:id/password", handler.UpdatePassword, RouteSpec{
+		Summary: "重置代理账号密码",
+		Tags:    []string{"代理账号管理"},
+		Input:   new(model.UpdateShopAccountPasswordParams),
+		Output:  nil,
+		Auth:    true,
+	})
+
+	Register(shopAccounts, doc, groupPath, "PUT", "/:id/status", handler.UpdateStatus, RouteSpec{
+		Summary: "启用/禁用代理账号",
+		Tags:    []string{"代理账号管理"},
+		Input:   new(model.UpdateShopAccountStatusParams),
+		Output:  nil,
+		Auth:    true,
+	})
 }

internal/routes/task.go

@@ -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,
 	})
 }