Go语言Gin怎么做Swagger文档_Go语言Gin Swagger教程【入门】

星明酱_1875

星明酱_1875

2026-04-12

873人浏览

原创

swag init 生成的 swagger.json 中 paths 为空,是因为 handler 函数缺少紧贴声明的 // @summary 和 // @router 注释,且函数必须首字母大写、位于非忽略文件中,否则不会被扫描。

go语言gin怎么做swagger文档_go语言gin swagger教程【入门】

swag init 生成的 docs/swagger.json 里 paths 为空,不是路径写错了,而是 handler 函数根本没被扫描到 —— 它只认带 // @Summary 的具名函数,且注释必须紧贴函数声明。

swag init 找不到接口?先看 handler 函数有没有“身份证”

swag 不解析 router.GET() 这类运行时注册,它只扫描 Go 源码中带 Swagger 注释的函数。没注释 = 没接口。

  • // @Summary 和 // @Router 是硬性要求,缺一不可;漏掉任意一个,该接口就不会出现在 swagger.json 的 "paths" 里
  • 注释必须写在 handler 函数定义正上方,不能隔空行,不能写在 func main() 里,也不能塞进匿名函数或闭包里
  • 函数名必须首字母大写(导出),否则 swag 解析器直接跳过
  • 别把 handler 放在 _test.go、mock_*.go 或被 //go:build ignore 标记的文件里 —— swag 默认忽略它们

参数不显示?@Param 写法和 Gin 实际取值方式要对得上

Gin 的 c.Param("id") 和 c.Query("page") 不会自动映射成 Swagger 参数,全靠 @Param 手动声明。写错类型或位置,参数就消失。

Go语言(Golang)1.26.0
Go语言(Golang)1.26.0

Go语言(Golang)1.26.0版本官方下载,版本号 1.26.0,适合旧项目维护、兼容性测试和指定版本开发环境搭建。

下载
  • c.Param("id") → // @Param id path int true "用户ID"(注意是 path,类型写 int 而非 string)
  • c.Query("page") → // @Param page query int false "页码" default(1)
  • c.ShouldBindJSON(&req) → // @Param req body models.User true "请求体",且 models.User 必须是可导出 struct,字段带 json: tag
  • 别用 map[string]interface{} 做 body 输入,swag 解析不了,文档里只会显示 object

启动报 panic: no required "doc" found?docs 包根本没加载

这个 panic 不是 swagger.json 缺失,而是 Gin 启动时找不到 docs.SwaggerInfo 变量 —— 说明生成的 docs 包压根没被 import。

  • 确保在 main.go(或启动文件)顶部写了:import _ "your-module-name/docs"(注意下划线导入)
  • swag init -g main.go 必须在 module 根目录执行,否则生成的 docs/docs.go 里 SwaggerInfo 初始化代码可能为空或路径错误
  • 检查 docs/docs.go 是否真实存在、是否含 var SwaggerInfo = ...,如果为空,说明全局注释(如 // @title)漏了或格式有硬伤
  • 注册路由时必须用 ginSwagger.WrapHandler(docs.Handler),不是 docs.Handler()(后者是调函数,不是传 handler)

Struct 字段不进 Response Model?导出 + tag + 可见性三者缺一不可

Swagger 的 model 是从 struct 定义推导的,但 Go 的字段可见性规则比 JSON 序列化更严:即使字段打了 json:"user_id",只要首字母小写,swag 就当它不存在。

  • 结构体名、字段名都必须首字母大写(导出)
  • 每个字段必须有 json: tag,且值非空(如 json:"user_id",不能是 json:"-")
  • 嵌套 struct 也要满足上述条件,否则链路中断,子字段不会展开
  • 如果结构体在其他 module,需在 main.go 顶部加 // @modelsPackage github.com/yourname/project/models

最容易被忽略的是注释和函数的物理距离 —— 看似写了 // @Summary,但中间夹了个空行或注释块,swag 就认为它不属于那个函数。生成前用 swag init -v 开启详细日志,能快速定位哪几个函数被跳过了。

golang免费学习笔记(深入):立即使用
在学习笔记中,你将探索golang的核心概念和高级技巧!

相关文章

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

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

下载

相关标签:

go语言

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

相关专题

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

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

2026.02.24

206

7

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

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

2026.02.24

113

7

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

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

2026.02.24

657

10

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

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

2026.02.24

218

7

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

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

2026.02.24

457

7

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

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

2026.02.24

208

7

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

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

2026.02.26

564

7

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

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

2026.02.26

225

7

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

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

2026.02.26

62

7

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程