Golang使用Swag搭建api文档的全过程
1. 简介
Gin是Golang目前最为常用的Web框架之一。
公司项目验收需要API接口设计说明书（Golang后端服务基于Gin框架编写），编写任务自然就落到了我们研发人员身上。
项目经理提供了文档模板，让我们参考模板来手动编写，要求两天内完成，时间紧任务重。
看了下文档中API接口设计内容，很简单，但是接口数量太多还需要调整文档格式，手动编写两天肯定搞不定。
发现API接口设计内容和swagger文档格式很相近，那能不能使用工具生成swagger文档后再转换为word格式呢？
和项目经理沟通了我的想法，项目经理回答说，内容丰富、格式统一就行，不要求完全参考模板中的格式来。
既然这样，那就开干吧！
2. 生成swagger.json文档
本章节仅为演示操作步骤，编写得很简洁。
2.1. 安装swag
首先需要安装swag命令行工具：go install github.com/swaggo/swag/cmd/swag@latest。
2.2. 新建示例项目
比如新建swagdoc项目：go mod init swagedoc。
2.3. 新建main.go文件并输入示例代码
package main
import (
"net/http"
"swagdoc/docs"
"github.com/gin-gonic/gin"
swaggerfiles "github.com/swaggo/files"
ginSwagger "github.com/swaggo/gin-swagger"
)
// @BasePath /api/v1
// PingExample godoc
// @Summary ping example
// @Schemes
// @Description do ping
// @Tags example
// @Accept json
// @Produce json
// @Success 200 {string} Helloworld
// @Router /example/helloworld [get]
func Helloworld(g *gin.Context) {
g.JSON(http.StatusOK, "helloworld")
}
func main() {
r := gin.Default()
docs.SwaggerInfo.BasePath = "/api/v1"
v1 := r.Group("/api/v1")
{
eg := v1.Group("/example")
{
eg.GET("/helloworld", Helloworld)
}
}
r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))
r.Run(":8080")
}
2.4. 生成swagger.json文档
执行命令swagger init命令生成swagger.json文档。文件目录结构如下图所示：
2.5. 访问api文档
执行下列命令运行示例程序：
go mod tidy go run ./main.go
在浏览器中访问api文档 ：
可以通过浏览器直接访问api：
3. 常见问题
3.1. Error parsing type definition报错如何解决？
若出现解析类型定义的错误，需要在执行swage init时加上对应的选项：
例如：swag init --parseDependency --parseInternal
3.2. 如何编写api注释？
参考 声明式注释格式。
4. 将swagger.json文档转换为word文档
可以使用 swagger转word文档在线工具 来进行转换。
如果在线工具不能使用，可以自行参考网上教程在本地搭建转换工具来进行转换，就不在此赘述了。
转换后的word文档效果图如下所示：
5. 参考资料
以上就是Golang使用Swag搭建api文档的全过程的详细内容，更多关于Golang Swag搭建api文档的资料请关注脚本之家其它相关文章！
相关文章
文件系统事件是指文件系统相关的各种操作和状态变化，当一个应用层的进程操作文件或目录时，会触发system call，内核的notification子系统可以守在那里，把该进程对文件的操作上报给应用层的监听进程，这篇文章主要介绍了Golang之文件系统事件监听,需要的朋友可以参考下2024-01-01
相信大家都知道不同语言之间的通信方式有很多种，这篇文章详细的介绍了PHP与Go语言之间如何通信，有需要的朋友们可以参考借鉴，下面来一起看看吧。2016-10-10
这篇文章主要介绍了如何利用golang和shell计算一个字符串的md5值,我们先用shell来计算一下,再去判断golang计算的md5值是否正确,文中有详细的图文介绍,需要的朋友可以参考下2024-03-03
本文深入讲解了Go语言中二维切片的概念与应用,用于表示矩阵、表格等二维数据结构,文中通过示例代码介绍的非常详细,需要的朋友们下面随着小编来一起学习学习吧2025-07-07
访问者是一种行为设计模式, 允许你在不修改已有代码的情况下向已有类层次结构中增加新的行为,本文将通过代码示例给大家详细的介绍一下Go设计模式之访问者模式,需要的朋友可以参考下2023-08-08
这篇文章主要给大家介绍了关于Go和Java算法详析之分数到小数的相关资料,文中通过实例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2022-08-08
本文主要介绍了GO语言匿名函数的几种使用方式,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧2025-08-08
这篇文章主要为大家介绍了Go语言数据结构之选择排序示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2022-08-08
这篇文章主要介绍了让GPT教你用go语言和C语言开发IDE配置学习,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪2023-10-10
这篇文章主要介绍了Go语言Telnet回音服务器的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-01-01
最新评论