先安装go-swagger
go get github.com/go-swagger/go-swagger
cd go-swagger
go install ./cmd/swagger
swag init
可以生成swagger信息,在项目根目录下面的docs文件夹下:
main函数入口放上swagger基本信息
// @title VPN
// @version 1.0
// @description null
// @host 192.168.33.2:8080
// @BasePath /
func main() {
// 引用数据库
db.InitDb(false)
// 引入路由组件
routers.InitRouter()
}
这里放得信息一般是
这个位置的信息
在路由位置处
安装依赖
go get swaggerFiles "github.com/swaggo/files"
go get "github.com/swaggo/gin-swagger"
加上:
r.GET("/swagger/*any", gs.WrapHandler(swaggerFiles.Handler))
重要的来了
要在routers文件上加上刚刚生成的docs文件路径
_ "awesomeProject/docs"
package routers
import (
"awesomeProject/api/user"
_ "awesomeProject/docs"