swaggo工具使用
swaggo工具使用
-g 多个存放api的go文件,空格隔开
-d 必须选择api文件存放的目录,不写的话则会从根目录下找main.go
//意思是从api目录下扫描api1.go、api2.go文件,默认生成docs目录
swag init -g api1.go api2.go -d api
gin使用示例
package main
import (
"github.com/gin-gonic/gin"
"github.com/swaggo/files"
"github.com/swaggo/gin-swagger"
_ "你的模块名/docs"
)
// @title Swagger Example API
// @version 1.0
// @description This is a sample server Petstore server.
// @termsOfService http://swagger.io/terms/
// @contact.name API Support
// @contact.url http://www.swagger.io/support
// @contact.email [email protected]
// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html
// @host petstore.swagger.io
// @BasePath /v2
func main() {
r := gin.New()
// The url pointing to API definition
url := ginSwagger.URL("http://localhost:8080/swagger/doc.json")
r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler, url))
r.Run()
}