- 第一步下载包
go get -u github.com/swaggo/swag/cmd/swag
- 第二步安装swag的程序
go install github.com/swaggo/swag/cmd/swag
安装完会在你配置的GOPATH录下的bin下生成一个swag.exe
- 第三步试用命令会在你的项目目录下生成docs文件夹
swag init
- 第四步配置swagger需要的文件
注意:_ "gin_gorm_jwt_demo/docs" 这个路径为你的项目名称 加上docs文件夹
import (
"gin_gorm_jwt_demo/service"
"github.com/gin-gonic/gin"
)
import (
_ "gin_gorm_jwt_demo/docs"
swaggerfiles "github.com/swaggo/files"
ginSwagger "github.com/swaggo/gin-swagger"
)
func Router() *gin.Engine {
r := gin.Default()
// Swagger 配置
r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))
r.GET("/test", service.Test)
r.GET("/example/helloworld", service.Helloworld)
r.GET("/example/helloworld2", service.Helloworld2)
return r
}
- 第五步 写配置文件
// 描述
// @Summary 这也是描述
// 一个大类别的名称
// @Tags 标题2
// 接受类型
// @Accept json
// 返回类型
// @Produce json
// 成功返回200 返回的类型
// @Success 200 {string} Helloworld
// 路由地址
// @Router /example/helloworld [get]
func Helloworld(g *gin.Context) {
g.JSON(http.StatusOK, "helloworld")
}
这就配置完了 然后每次修改配置文件的话 重写执行swag init 生成新的swagger文档
启动项目访问 http://localhost:8080/swagger/index.html