Go整合Swagger

110 阅读1分钟

Go整合Swagger

第一步 从GitHub上获取swagger的安装包

go get -u github.com/swaggo/swag/cmd/swag

第二步 找到下载下来的的源代码 并且找到源代码的main函数

image.png

使用 go install 命令执行该main函数 对swagger的源代码进行编译

第三步 再从GitHub上面拉取两个文件

go get -u github.com/swaggo/gin-swagger
go get -u github.com/swaggo/files

第四步 使用代码进行swagger相关的配置 比如静态资源的地址映射

这里我写在了配置类中 代码基本是固定的 可以直接用

import (
   _ "go.mod里面的项目名/docs"
   "github.com/gin-gonic/gin"
   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))
   return r

}

第五步 执行 swag init 生成doc.html文件就可以了

整合后的基本使用