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文档的资料请关注脚本之家其它相关文章！
相关文章
golang有包循环引用问题,用过的应该都知道,下面这篇文章主要给大家介绍了关于golang包循环引用的几种解决方案,文中通过实例代码介绍的非常详细,需要的朋友可以参考下2022-09-09
这篇文章主要给大家介绍了关于Go语言中利用http发起Get和Post请求的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧。2017-11-11
分布式锁是控制分布式系统之间同步访问共享资源的一种方式。如果不同的系统或是同一个系统的不同主机之间共享了一个或一组资源，那么访问这些资源时，需要通过一些互斥手段来防止彼此之间的干扰以保证一致性，在这种情况下，就需要使用分布式锁了2022-12-12
这篇文章主要介绍了golang 跳出for循环操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2020-12-12
这篇文章主要介绍了goland设置控制台折叠效果,本文通过图文并茂的形式给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2020-12-12
本文主要介绍了golang redigo发布订阅使用的方法，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2021-10-10
Golang 支持交叉编译，在一个平台上生成另一个平台的可执行程序,只需要按照我下面的这个环境变量表设置对应的环境变量就可以了，下面文章将对该内容做详细介绍，感兴趣的小伙伴可以参考一下2021-10-10
生成器是一种创建型设计模式,使你能够分步骤创建复杂对象,本文主要介绍了go生成器模式的具体使用,具有一定的参考价值,感兴趣的可以了解一下2024-01-01
这篇文章主要介绍了Go语言简单实现Vigenere加密算法，文章围绕主题展开详细的内容介绍，具有一定的参考价值，需要的朋友可以参考一下2022-09-09
go程序测试CPU占用率统计ps vs top两种不同方式对比
这篇文章主要为大家介绍了go程序测试CPU占用率统计ps vs top两种不同方式对比，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2023-05-05
最新评论