0

0

Golang Web如何实现接口文档_Golang Swagger接口文档

P粉602998670

P粉602998670

发布时间:2026-02-24 13:48:11

|

713人浏览过

|

来源于php中文网

原创

swag init 生成的 docs 没有接口,最常见原因是 handler 函数上方未添加 // @router 和 // @success 等注释,且注释必须紧贴函数声明、无空行;同时需用 -d 参数指定多目录路径,如 ./handlers,./api。

golang web如何实现接口文档_golang swagger接口文档

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

最常见原因是没在 handler 函数上方加 // @Router// @Success 等注释。Swag 不解析函数体,只扫描注释块,且要求注释紧贴函数声明(中间不能有空行)。
另外,swag init 默认只扫描当前目录及子目录下的 .go 文件,如果路由注册和 handler 分散在不同包(比如 handlers/api/),需显式指定路径:

swag init -g main.go -d ./handlers,./api
不加 -d 参数时,它根本不会看其他目录。

如何让 @Param 正确识别 query/path/header 参数?

参数类型必须与实际接收方式严格匹配,否则 Swagger UI 不会渲染输入框或下拉项。
常见写法:

  • // @Param id path string true "用户ID" → 对应 /:id 路由段
  • // @Param page query int false "页码" default(1) → 解析 URL 查询参数 ?page=2
  • // @Param X-Auth-Token header string true "认证Token" → 提取请求头

注意:defaultenumminimum 等修饰符必须写在引号外,且中间无空格;stringint 是 Swagger 支持的基础类型,不要写 uint64 或自定义 struct 名。

Android JNI开发入门与提高 中文WORD版
Android JNI开发入门与提高 中文WORD版

本文档主要讲述的是Android JNI开发入门与提高;JNI在Android系统中有着广泛的应用。Android系统底层都是C/C++实现的,上层提供的API都是Java的,Java通过JNI调用底层的实现。比如:Android API多媒体接口MediaPlayer类,其实底层通过JNI调用libmedia库。希望本文档会给有需要的朋友带来帮助;感兴趣的朋友可以过来看看

下载

如何避免 swag init 报错 “undefined type”?

Swag 在解析注释时会尝试校验结构体是否可导出、字段是否可序列化。报这个错通常是因为:
• 注释里写了 // @Success 200 {object} models.User,但 models.User 所在包没被当前扫描文件 import;
User 字段未导出(小写开头),或嵌套了不可序列化的类型(如 func()map[interface{}]string);
• 使用了别名类型(如 type UserID int64),但没加 // @Model 注释说明。

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

解决方法:
• 确保所有被引用的结构体都出现在扫描路径中,且被至少一个 .go 文件 import;
• 用 // @Model 显式声明别名或嵌套结构:

// @Model User
// @Description 用户基本信息
type User struct {
    ID   int64  `json:"id"`
    Name string `json:"name"`
}

如何把 Swagger UI 集成进 Gin/Echo 路由?

Swag 生成的是静态资源(docs/docs.go),不是 HTTP 服务。集成关键在于注册路由时指向正确的 handler:
• Gin:

import _ "your-project/docs"
r := gin.New()
r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))

• Echo:
e := echo.New()
e.GET("/swagger/*", echoSwagger.WrapHandler(swaggerFiles.Handler))

注意:/swagger/*any 中的 *any 是 Gin 的通配符写法,Echo 用 *;路径末尾斜杠、大小写必须和生成的 docs/swagger.json 实际路径一致(默认是根路径下);如果改过 swag init -o 输出目录,要同步更新 swaggerFiles.Handler 的资源加载逻辑。

最容易被忽略的是:每次修改接口注释后,必须重新运行 swag init,否则浏览器访问看到的仍是旧文档——它不热重载,也不监听文件变化。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

207

2024.02.23

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

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

242

2024.02.23

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

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

349

2024.02.23

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

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

212

2024.03.05

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

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

405

2024.05.21

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

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

365

2025.06.09

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

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

200

2025.06.10

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

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

1091

2025.06.17

苹果官网入口与在线访问指南_中国站点快速直达与iPhone查看方法
苹果官网入口与在线访问指南_中国站点快速直达与iPhone查看方法

本专题汇总苹果官网最新可用入口及中国站点访问方式,涵盖官网直达链接、iPhone官方页面查看方法与常见访问说明,帮助用户快速进入苹果官方网站,便捷了解产品信息与官方服务。

4

2026.02.24

热门下载

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

精品课程

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

共32课时 | 5.5万人学习

Go语言实战之 GraphQL
Go语言实战之 GraphQL

共10课时 | 0.9万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号