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

Go语言Gin如何做Swagger文档_Go语言Gin Swagger教程【推荐】

为什么 swag init 生成的 docs 文件里没有接口?

因为 Gin 路由没被 swag 工具“看见”——它不解析 router.GET() 这类运行时注册,只扫描带 Swagger 注释的 Go 源文件。你得在 handler 函数上方手动加 // @Summary 这类注释,否则哪怕路由跑得通,文档里也空空如也。

常见错误现象:docs/swagger.json 生成了,但 "paths": {} 或只有 /swagger/* 路由,你的业务接口一个没出现。

Gin 注册 Swagger UI 时提示 no required "doc" found

这是 gin-swagger 找不到 docs.SwaggerInfo 的典型报错,本质是 docs 包没被正确导入或初始化。

使用场景:你执行了 swag init,也写了注释,但运行后访问 /swagger/index.html 直接 panic。

@Param 怎么写才能让 query/path/body 参数正确显示?

Swagger 注释里参数类型和位置不匹配,会导致字段消失或类型错乱。Gin 本身不约束参数来源,但 swag 需要你明确告诉它“这个变量从哪儿来、长什么样”。

参数差异直接影响前端试调用能否自动填充:

上线后 Swagger UI 能访问但接口 404 或跨域失败

Swagger UI 是静态页面,它发出的请求走的是浏览器环境,和你的 Gin 后端服务是两个上下文。404 通常是因为 API 前缀不一致,跨域则是因为没开 CORS,跟文档生成无关。

性能 / 兼容性影响:Swagger UI 本身不消耗服务端资源,但暴露在生产环境有安全风险,建议仅限开发/测试环境启用。

最容易被忽略的一点:每次改了 handler 的参数或返回结构,必须重新跑 swag init,它不会监听文件变化。文档和代码不同步,比没有文档更危险。

本文转载于:互联网 如有侵犯,请联系zhengruancom@outlook.com删除。
免责声明:正软商城发布此文仅为传递信息,不代表正软商城认同其观点或证实其描述。