Gin框架结合Swagger在中间件中自动剔除非公开接口

星宇君_1995

星宇君_1995

2026-09-28

899人浏览

原创

swagger文档生成与gin中间件完全隔离,需通过注释管理(显式@router)、路由分组(公开/内部接口分离)和目录隔离实现非公开接口剔除与鉴权控制。

gin框架结合swagger在中间件中自动剔除非公开接口

gin 中间件本身不感知 Swagger 文档生成逻辑,**无法自动剔除非公开接口**——这是常见误解的根源。Swagger(如 swaggo/swag)是在编译期通过注释解析生成 docs/docs.go 的静态描述文件,它和运行时的中间件完全隔离。 你真正需要的,是让「非公开接口」既不被 Swagger 收录,又在运行时不被中间件拦截(或反向:只对公开接口应用鉴权类中间件)。下面分两块说清楚怎么做、为什么、容易错在哪。

Swagger 注释必须显式标注 // @Router 才会进文档

Swaggo 不扫描所有 GET/POST 路由,只认带完整 OpenAPI 注释的 handler。没写 // @Router、// @Success 的路由,哪怕注册了也不会出现在 swagger.json 里。

所以“剔除”不是中间件的事,是注释管理的事:

  • 公开 API 必须补全注释,例如:
    // @Router /api/users [get]
    // @Success 200 {array} model.User
    func GetUsers(c *gin.Context) { ... }
  • 内部健康检查、调试端点、管理后台接口等,**不加任何 @Router 注释**,它们自然不出现在 Swagger 页面中
  • 如果用了 swag init -g 自动扫描,确保 -g 指向的入口文件只包含对外暴露的 handler 文件(别把 internal/admin/ 也塞进去)

中间件注册要按路由组分离,而非靠“识别是否公开”

你没法在中间件里判断当前请求“是否该出现在 Swagger”,因为:c.Request.URL.Path 是运行时路径,而 Swagger 文档是编译期产物,二者无映射关系。

正确做法是提前规划路由层级:

Gin框架 1.9.0
Gin框架 1.9.0

Gin框架 1.9.0版本源码包下载,版本号 1.9.0,适合需要 sonic JSON 支持、路由修复和内容协商改进的 Go Web 开发场景。

下载
  • 用 router.Group("/api") 包公开接口,挂载 AuthMiddleware()、RateLimitMiddleware()
  • 用 router.Group("/health") 或 router.Group("/debug") 包内部接口,**不挂任何鉴权中间件**
  • 避免这种写法:
    router.Use(AuthMiddleware()) // 全局注册 → 把 /health 也拦了

如果真想统一管控,可写个白名单校验中间件,但它是硬编码路径判断,不是“自动识别”:

func PublicOnlyMiddleware() gin.HandlerFunc {
    publicPaths := map[string]bool{
        "/health": true,
        "/metrics": true,
        "/swagger/*any": true,
    }
    return func(c *gin.Context) {
        path := c.Request.URL.Path
        for p := range publicPaths {
            if strings.HasPrefix(path, p) || (strings.HasSuffix(p, "/*any") && strings.HasPrefix(path, strings.TrimSuffix(p, "/*any"))) {
                c.Next()
                return
            }
        }
        // 其他路径走鉴权
        AuthMiddleware()(c)
    }
}

⚠️ 注意:/swagger/*any 这种通配需配合 gin.RouterGroup 的 wildcard 支持,且 swag serve 通常走独立 HTTP 服务,不经过 Gin 路由——所以这行实际意义不大,纯属混淆。

Swagger UI 静态资源路径别被中间件误杀

如果你手动注册了 Swagger UI 路由(比如用 gin-swagger),常见错误是把它挂到了受鉴权保护的路由组下:

  • ❌ 错误:
    apiGroup := router.Group("/api", AuthMiddleware())
    apiGroup.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
    → 访问 /api/swagger/index.html 会 401
  • ✅ 正确:
    router.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
    → 顶层注册,不套中间件

另外确认 swaggerFiles.Handler 是从 github.com/swaggo/files 加载的,不是你自己写的 handler —— 后者容易漏掉 OPTIONS 或静态文件头,导致 UI 加载失败。

中间件和 Swagger 属于两个生命周期:一个在请求进来时动态执行,一个在代码编译时静态生成。试图让前者“自动适配”后者,本质上是在混用不同抽象层级的机制。真正省事的做法,是靠路由分组 + 注释规范 + 目录隔离,三者配合,比写一堆运行时判断靠谱得多。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Golang 入门学习路线:从零基础到上手开发
Golang 入门学习路线:从零基础到上手开发

Golang 入门路线涵盖从零到上手的核心路径:首先打牢基础语法与切片等底层机制;随后攻克 Go 的灵魂——接口设计与 Goroutine 并发模型;接着通过 Gin 框架与 GORM 深入 Web 开发实战;最后在微服务与云原生工具开发中进阶,旨在培养具备高性能并发处理能力的后端工程师。

2026.02.24

186

7

Golang 疑难杂症解决指南:常见问题排查与优化
Golang 疑难杂症解决指南:常见问题排查与优化

《Golang 疑难杂症解决指南》聚焦开发过程中常见却棘手的问题,从并发模型、内存管理、性能瓶颈到工程化实践逐步拆解。通过真实案例与调试思路,帮助开发者定位问题根因,建立系统化排查方法。不只给出答案,更强调分析路径与工具使用,让你在复杂 Go 项目中具备持续解决问题的能力。

2026.02.24

113

7

Golang 运行与部署实战:从本地到云端
Golang 运行与部署实战:从本地到云端

《Golang 运行与部署实战》围绕 Go 应用从开发完成到稳定上线的完整流程展开,系统讲解编译构建、环境配置、日志与配置管理、容器化部署以及常见运维问题处理。结合真实项目场景,拆解自动化构建与持续部署思路,帮助开发者建立可靠的发布流程,提升服务稳定性与可维护性。

2026.02.24

617

10

Golang 面试题精选:高频问题与解答
Golang 面试题精选:高频问题与解答

Golang 面试题精选》系统整理企业常见 Go 技术面试问题,覆盖语言基础、并发模型、内存与调度机制、网络编程、工程实践与性能优化等核心知识点。每道题不仅给出答案,还拆解背后的设计原理与考察思路,帮助读者建立完整知识结构,在面试与实际开发中都能更从容应对复杂问题。

2026.02.24

198

7

Golang 性能优化专题:提升应用效率
Golang 性能优化专题:提升应用效率

《Golang 性能优化专题》聚焦 Go 应用在高并发与大规模服务中的性能问题,从 profiling、内存分配、Goroutine 调度、GC 机制到 I/O 与锁竞争逐层分析。结合真实案例讲解定位瓶颈的方法与优化策略,帮助开发者建立系统化性能调优思维,在保证代码可维护性的同时显著提升服务吞吐与稳定性。

2026.02.24

437

7

Golang 生态工具与框架:扩展开发能力
Golang 生态工具与框架:扩展开发能力

《Golang 生态工具与框架》系统梳理 Go 语言在实际工程中的主流工具链与框架选型思路,涵盖 Web 框架、RPC 通信、依赖管理、测试工具、代码生成与项目结构设计等内容。通过真实项目场景解析不同工具的适用边界与组合方式,帮助开发者构建高效、可维护的 Go 工程体系,并提升团队协作与交付效率。

2026.02.24

168

7

Golang 并发编程专题:掌握多核时代的核心技能
Golang 并发编程专题:掌握多核时代的核心技能

《Golang 并发编程专题:掌握多核时代的核心技能》系统讲解 Go 在并发领域的设计哲学与实践方法,深入剖析 goroutine、channel、调度模型与并发安全机制,结合真实场景与性能思维,帮助开发者构建高吞吐、低延迟、可扩展的并发程序,全面提升多核时代的工程能力。

2026.02.26

524

7

Golang Web 开发路线:构建高效后端服务
Golang Web 开发路线:构建高效后端服务

《Golang Web 开发路线:构建高效后端服务》围绕 Go 在后端领域的工程实践,系统讲解 Web 框架选型、路由设计、中间件机制、数据库访问与接口规范,结合高并发与可维护性思维,逐步构建稳定、高性能、易扩展的后端服务体系,帮助开发者形成完整的 Go Web 架构能力。

2026.02.26

185

7

Golang 实际项目案例:从需求到上线
Golang 实际项目案例:从需求到上线

《Golang 实际项目案例:从需求到上线》以真实业务场景为主线,完整覆盖需求分析、架构设计、模块拆分、编码实现、性能优化与部署上线全过程,强调工程规范与实践决策,帮助开发者打通从技术实现到系统交付的关键路径,提升独立完成 Go 项目的综合能力。

2026.02.26

62

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Gin框架快速入门指南
Gin框架快速入门指南

共0课时 | 0人学习

Gin框架官方中文文档
Gin框架官方中文文档

共0课时 | 0人学习

Go语言Gin框架全套实战教程
Go语言Gin框架全套实战教程

共0课时 | 0人学习