讲师中心 微信公众号
AI工具推荐 视频效率加速

Golang Web开发中如何做接口文档_Golang Swagger使用方法

浅强姑娘_8066

浅强姑娘_8066

发布时间:2026-02-10 12:03:29

|

615人浏览过

|

来源于php中文网

原创

swag init 生成的 docs 没有接口,常见原因是 handler 函数上方未添加或未正确书写 Swagger 注释(如 // @Summary),或注释与函数间存在空行;swag 仅扫描符合规范的 Go 注释,不解析函数体或路由逻辑。

golang web开发中如何做接口文档_golang swagger使用方法

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

常见原因是没在 handler 函数上方加 // @Summary 这类注释,或者注释没写在函数声明正上方(中间不能空行)。Go 的 swag 工具只扫描符合 Swagger 注释规范的 Go 注释,不解析函数体或路由注册逻辑。

实操建议:

立即学习“go语言免费学习笔记(深入)”;

Golang Samber Hot
Golang Samber Hot

在 Golang 中使用 samber/hot 进行内存缓存,支持 LRU、LFU、TinyLFU、W‑TinyLFU、S3FIFO、ARC、TwoQueue、SIEVE、FIFO 等淘汰算法,提供 TTL、缓存加载器及分片功能。

下载
  • 确保每个 HTTP handler 函数前紧贴着写完整注释块,例如:
    // @Summary 获取用户信息
    // @Tags user
    // @Accept json
    // @Produce json
    // @Param id path int true "用户ID"
    // @Success 200 {object} model.User
    // @Router /users/{id} [get]
    func GetUser(c *gin.Context) { ... }
  • 路径参数、查询参数、请求体、响应结构体都必须显式用 @Param、@Success 等标注,swag 不会自动推导 struct 字段是否可为空或是否必填
  • 如果用了 gin 的 c.ShouldBindJSON(&v),记得给 v 对应的 struct 字段加上 json: tag,否则 swag 无法识别字段名和类型

如何让 swag init 扫描到嵌套的 handler 文件?

swag init 默认只扫描当前目录及子目录下的 .go 文件,但如果你把 handler 分散在 handlers/、api/v1/ 等多层目录,又没显式指定入口,它可能漏掉部分文件。

实操建议:

立即学习“go语言免费学习笔记(深入)”;

  • 运行时加 -g 参数指定主入口文件(通常是 main.go),例如:swag init -g cmd/myapp/main.go
  • 用 -d 显式指定要扫描的目录,支持多个:swag init -d internal/handlers -d internal/api
  • 避免在非 handler 文件(如 config、model)里写 Swagger 注释,否则容易污染文档或引发解析错误

Swagger UI 页面报错 “Failed to fetch” 或空白?

多数情况是生成的 docs/docs.go 没被引入,或静态资源路径没配对。Gin 默认不自动提供 /swagger/*any 路由,需手动挂载。

实操建议:

立即学习“go语言免费学习笔记(深入)”;

  • 确认已执行 swag init 且生成了 docs/docs.go 文件;该文件必须被 go build 编译进去,不能被 //go:build ignore 排除
  • Gin 中挂载方式必须用 ginSwagger.WrapHandler(swaggerFiles.Handler),不是直接 router.Static —— 后者不会处理 swagger.json 的动态生成
  • 检查浏览器控制台:若提示 swagger.json 404,说明 docs/docs.go 未生效;若提示 CORS 错误,说明后端没开跨域(但 Swagger UI 本地打开时通常不走跨域)

struct 字段不显示在 Model 或参数中?

Swagger 文档里的 Model 完全依赖 struct 的字段 tag 和注释。没有 json: tag 的字段会被忽略,私有字段(首字母小写)默认不导出,即使加了 tag 也无效。

实操建议:

立即学习“go语言免费学习笔记(深入)”;

  • 所有要出现在文档中的字段必须是导出字段(大写开头),并带 json: tag,例如:Name string `json:"name"`
  • 用 // @description 在 struct 上方补充说明,swag 会将其作为 Model 描述:
    // @description 用户基本信息
    type User struct {
        ID   uint   `json:"id"`
        Name string `json:"name"`
    }
  • 嵌套 struct 需要单独定义类型(不能用 map[string]interface{} 或匿名 struct),否则 swag 无法解析其结构
Gin + Swag 的集成关键不在“怎么装”,而在于注释位置、字段可见性、生成路径三者的严格匹配——少一个空格、错一个大小写、漏一个 tag,文档就断在某个环节。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

499

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

596

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1056

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

771

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1546

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

4334

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

1974

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

3886

2025.06.17

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

100

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn