Go-Swagger是一个基于OpenAPI 2.0标准的RESTful API文档生成器,它可以通过注释和代码自动生成API文档,并且提供了一系列方便快捷的命令行工具和模板库。Swag是Go-Swagger中非常重要的一个部分,它提供了在Golang中使用Swagger注释生成API文档的功能。本文主要介绍swag与net/http集成时所需掌握的知识点。
- 安装
在开始使用Swag之前,我们需要先安装相应依赖包。在终端中输入以下命令:
go get -u github.com/swaggo/swag/cmd/swag
该命令会下载并安装swag到$GOPATH/bin目录下。
- 使用
接下来我们就可以利用Swag来生成相应API文档了。首先,在你的项目根目录下执行以下命令:
swag init
该命令会读取您项目中所有带有Swagger注释(// swagger:operation
)的文件,并根据这些注释自动生成Swagger API文档JSON文件(swagger.json)以及HTML页面(index.html)。
然后,在main.go文件中加入如下代码:
package main
import (
"github.com/gin-gonic/gin"
"github.com/swaggo/gin-swagger"
"github.com/swaggo/gin-swagger/swaggerFiles"
_ "path/to/your/docs" // 导入生成的docs文件
)
func main() {
r := gin.Default()
// 添加