展开菜单
首页 精品内容 本月促销 装机必备 Windows macOS软件 IOS软件 Android AI PDF教程 专题
全部分类

当前位置:

首页 > 编程开发 > Go语言Gin集成Swagger教程

Go语言Gin集成Swagger教程

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

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/* 路由,你的业务接口一个没出现。

  • 确保注释写在 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,它不会监听文件变化。文档和代码不同步,比没有文档更危险。

本文内容来源于互联网,如有侵权请联系删除。
作者最新文章
编程开发
相关文章 更多
精品专题 更多
本月促销

正软商城本月促销专区,汇集办公、设计、安全、影音、系统工具及AI软件等正版软件优惠活动,提供限时折扣、特价授权和优惠购买信息,活动库存及价格以页面实时展示为准。

装机必备

正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

Windows

正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

macOS软件

正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

IOS软件

正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

AI

正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

PDF教程

正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

Mac软件 更多
灵活计算器
灵活计算器

灵活计算器是一款笔记式算数应用,支持实时计算、动态关联和云端同步功能。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

赤友清理大师
赤友清理大师

赤友清理大师是一款为 Mac 设计的智能清理优化工具,可精准扫描垃圾、大文件、重复文件等,释放磁盘空间。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

极度公式
极度公式

极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

图几
图几

图几是一款适用于 macOS 的截图、标注与美化工具,支持离线操作保障隐私。界面整理和高频系统操作被放到一起考虑,桌面或窗口内容一多时,管理起来会更省心。

密码键盘
密码键盘

密码键盘是一款兼具安全性与便捷性的高效密码管理器。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

思源笔记
思源笔记

思源笔记是一款本地笔记软件,提供所见即所得的编辑方式,为长文写作带来顺滑的体验。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

Office 365 简体中文
Office 365 简体中文

一款文字处理软件,一种订阅式的跨平台办公软件,基于云平台提供多种服务,通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合,Office 365 可让任何人使用任何设备随时随地创建和共享内容。

WALTR PRO
WALTR PRO

WALTR是一款电脑至iOS文件传输转换工具,操作简单,快速实现文件识别与传送。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

CodeExpander
CodeExpander

CodeExpander 是一款快捷短语输入增强工具,通过键入缩写自动展开为自定义文段,提升工作效率。任务管理和过程控制会更完整,持续下载、批量同步或需要稳定传输流程的场景会更适合它。

Mountain Duck
Mountain Duck

Mountain Duck 是一款能将多个网盘挂载到本地的工具,像本地磁盘一样使用网盘。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

Menuist
Menuist

Menuist 是一款面向 macOS 的 Finder 右键菜单增强工具,主要用来补充新建文件、快捷导航等常用操作,让日常文件管理和访问路径时更高效、更顺手。

Mole
Mole

Mole 是一款专为 Mac 设计的深度清理优化工具,涵盖缓存清理、应用管理及实时状态监控等功能。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

WINDOWS 更多
Windows 10
Windows 10

Windows 10 是一款微软推出的经典操作系统,拥有硬件兼容性与多任务处理能力。它更偏向把系统状态查看和常用调节动作放在一起,适合需要持续观察和微调设备状态的场景。

极度公式
极度公式

极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

密码键盘
密码键盘

密码键盘是一款兼具安全性与便捷性的高效密码管理器。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

思源笔记
思源笔记

思源笔记是一款本地笔记软件,提供所见即所得的编辑方式,为长文写作带来顺滑的体验。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

傲梅轻松备份
傲梅轻松备份

傲梅轻松备份是一款专业易用的数据备份软件,为重要数据提供安全保障。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

Office 365 简体中文
Office 365 简体中文

一款文字处理软件,一种订阅式的跨平台办公软件,基于云平台提供多种服务,通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合,Office 365 可让任何人使用任何设备随时随地创建和共享内容。

Wise Folder Hider Pro
Wise Folder Hider Pro

Wise Folder Hider Pro 是一款专业级文件和文件夹隐藏加密软件,为私密数据添加多重保护。高频操作更强调就近处理,浏览、整理和跨目录移动文件时,来回切换和重复点击都会少很多。

WALTR PRO
WALTR PRO

WALTR是一款电脑至iOS文件传输转换工具,操作简单,快速实现文件识别与传送。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

CodeExpander
CodeExpander

CodeExpander 是一款快捷短语输入增强工具,通过键入缩写自动展开为自定义文段,提升工作效率。任务管理和过程控制会更完整,持续下载、批量同步或需要稳定传输流程的场景会更适合它。

PinStack
PinStack

PinStack是一款轻量级的Windows平台剪贴板管理工具,优化您的剪贴板使用体验。它更偏向把系统状态查看和常用调节动作放在一起,适合需要持续观察和微调设备状态的场景。

Mountain Duck
Mountain Duck

Mountain Duck 是一款能将多个网盘挂载到本地的工具,像本地磁盘一样使用网盘。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

Seer
Seer

Seer是一款在Win平台下的空格键功能增强效率工具,只需轻敲空格键,就能预览几乎任何格式的文件。它更适合把零散的小功能集中起来使用,处理高频琐碎任务时会更省事。