swag init 生成的 docs 中无接口,因 swag 仅扫描带 Swagger 注释(如 // @Summary)的具名 handler 函数,不解析 Gin 运行时路由;需确保注释紧邻函数、格式正确、docs 包被下划线导入且 ginSwagger.WrapHandler 正确注册。

为什么 swag init 生成的 docs 文件里没有接口?
因为 Gin 路由没被 swag 工具“看见”——它不解析 router.GET() 这类运行时注册,只扫描带 Swagger 注释的 Go 源文件。你得在 handler 函数上方手动加 // @Summary 这类注释,否则哪怕路由跑得通,文档里也空空如也。
常见错误现象:docs/swagger.json 生成了,但 "paths": {} 或只有 /swagger/* 路由,你的业务接口一个没出现。
- 确保注释写在 handler 函数定义正上方(不能隔空行,不能写在
func main()里) - 每个 HTTP 方法(
GET/POST)对应一个独立 handler 函数,别把多个逻辑塞进同一个函数再靠参数分支 - 注释块必须以
// @开头,大小写敏感,比如// @Success不能写成// @success - 如果 handler 是闭包或匿名函数,
swag完全无法识别,必须是具名函数
Gin 注册 Swagger UI 时提示 no required "doc" found
这是 gin-swagger 找不到 docs.SwaggerInfo 的典型报错,本质是 docs 包没被正确导入或初始化。
使用场景:你执行了 swag init,也写了注释,但运行后访问 /swagger/index.html 直接 panic。
- 检查是否在 main.go 或启动文件里 import 了生成的
docs包,例如import _ "your-project/docs"(注意下划线导入) - 确认
swag init命令是在项目根目录执行的,且-g参数指向正确的入口文件(如swag init -g main.go) - 生成的
docs/docs.go文件里必须包含SwaggerInfo变量;如果该文件为空或报错,说明注释格式有硬伤(比如少了个// @title) - Gin 中注册方式必须用
ginSwagger.WrapHandler(docs.Handler),不能直接传docs.Handler()(后者是函数调用,不是 handler)
@Param 怎么写才能让 query/path/body 参数正确显示?
Swagger 注释里参数类型和位置不匹配,会导致字段消失或类型错乱。Gin 本身不约束参数来源,但 swag 需要你明确告诉它“这个变量从哪儿来、长什么样”。
参数差异直接影响前端试调用能否自动填充:
- query 参数:用
// @Param name query string false "描述",string是类型,false表示非必填 - path 参数(如
/user/{id}):写// @Param id path int true "用户ID",注意类型写int而不是string,即使 Gin 里用c.Param("id")拿到的是字符串 - body 参数:必须配合
// @Success 200 {object} YourStruct,且结构体需导出字段(首字母大写),并加上json:tag,否则字段不显示 - 数组类型写
[]string,不要写string[];复杂对象嵌套直接写结构体名,无需展开
上线后 Swagger UI 能访问但接口 404 或跨域失败
Swagger UI 是静态页面,它发出的请求走的是浏览器环境,和你的 Gin 后端服务是两个上下文。404 通常是因为 API 前缀不一致,跨域则是因为没开 CORS,跟文档生成无关。
性能 / 兼容性影响:Swagger UI 本身不消耗服务端资源,但暴露在生产环境有安全风险,建议仅限开发/测试环境启用。
- 检查 UI 页面里发起的请求 URL 是否带了多余的前缀(比如 UI 认为接口在
/api/user,但实际 Gin 注册在/user),可通过// @BasePath统一修正 - 跨域问题不是 Swagger 的锅,要在 Gin 中显式启用 CORS,例如用
github.com/gin-contrib/cors中间件 - 生产环境务必禁用 Swagger UI,至少用路由分组 + 环境变量控制,比如只在
env == "dev"时注册ginSwagger路由 - 如果用了反向代理(Nginx),确保
/swagger/*和 API 路径的代理规则一致,避免路径重写导致 mismatch
最容易被忽略的一点:每次改了 handler 的参数或返回结构,必须重新跑 swag init,它不会监听文件变化。文档和代码不同步,比没有文档更危险。