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:
@@ -226,20 +226,32 @@ func initMiddleware(app *fiber.App, cfg *config.Config, appLogger *zap.Logger) {
|
||||
|
||||
// initRoutes 注册路由
|
||||
func initRoutes(app *fiber.App, cfg *config.Config, result *bootstrap.BootstrapResult, queueClient *queue.Client, db *gorm.DB, redisClient *redis.Client, appLogger *zap.Logger) {
|
||||
// 注册模块化路由
|
||||
routes.RegisterRoutes(app, result.Handlers, result.Middlewares)
|
||||
|
||||
// API v1 路由组(用于受保护的端点)
|
||||
v1 := app.Group("/api/v1")
|
||||
|
||||
// 可选:启用限流器
|
||||
if cfg.Middleware.EnableRateLimiter {
|
||||
initRateLimiter(v1, cfg, appLogger)
|
||||
rateLimitMiddleware := createRateLimiter(cfg, appLogger)
|
||||
applyRateLimiterToBusinessRoutes(app, rateLimitMiddleware, appLogger)
|
||||
}
|
||||
|
||||
routes.RegisterRoutes(app, result.Handlers, result.Middlewares)
|
||||
}
|
||||
|
||||
// initRateLimiter 初始化限流器
|
||||
func initRateLimiter(router fiber.Router, cfg *config.Config, appLogger *zap.Logger) {
|
||||
// applyRateLimiterToBusinessRoutes 将限流器应用到真实业务路由组
|
||||
func applyRateLimiterToBusinessRoutes(app *fiber.App, rateLimitMiddleware fiber.Handler, appLogger *zap.Logger) {
|
||||
adminGroup := app.Group("/api/admin")
|
||||
adminGroup.Use(rateLimitMiddleware)
|
||||
|
||||
h5Group := app.Group("/api/h5")
|
||||
h5Group.Use(rateLimitMiddleware)
|
||||
|
||||
personalGroup := app.Group("/api/c/v1")
|
||||
personalGroup.Use(rateLimitMiddleware)
|
||||
|
||||
appLogger.Info("限流器已应用到业务路由组",
|
||||
zap.Strings("paths", []string{"/api/admin", "/api/h5", "/api/c/v1"}),
|
||||
)
|
||||
}
|
||||
|
||||
// createRateLimiter 创建限流器中间件
|
||||
func createRateLimiter(cfg *config.Config, appLogger *zap.Logger) fiber.Handler {
|
||||
var rateLimitStorage fiber.Storage
|
||||
|
||||
if cfg.Middleware.RateLimiter.Storage == "redis" {
|
||||
@@ -255,11 +267,11 @@ func initRateLimiter(router fiber.Router, cfg *config.Config, appLogger *zap.Log
|
||||
appLogger.Info("限流器使用内存存储")
|
||||
}
|
||||
|
||||
router.Use(internalMiddleware.RateLimiter(
|
||||
return internalMiddleware.RateLimiter(
|
||||
cfg.Middleware.RateLimiter.Max,
|
||||
cfg.Middleware.RateLimiter.Expiration,
|
||||
rateLimitStorage,
|
||||
))
|
||||
)
|
||||
}
|
||||
|
||||
func startServer(app *fiber.App, cfg *config.Config, appLogger *zap.Logger) {
|
||||
|
||||
Reference in New Issue
Block a user