Gin Swagger 配置
swagger是一套基于OpenAPI规范构建的开源工具,使用RestApi。swagger-ui 呈现出来的是一份可交互式的API文档,可以直接在文档页面尝试API的调用。
gin-swagger 是基于注释生成 API 文档,项目地址:https://github.com/swaggo/swag。
一、安装
## swagger 依赖
go get "github.com/swaggo/files"
go get "github.com/swaggo/gin-swagger"
## swagger 命令行工具
go install github.com/swaggo/swag/cmd/swag
二、注册swagger路由信息
Router.go
package service
import (
"ginchat/docs"
"github.com/gin-gonic/gin"
swaggerFiles "github.com/swaggo/files"
ginSwagger "github.com/swaggo/gin-swagger"
)
func (app *Config) Router() *gin.Engine {
r := gin.Default()
docs.SwaggerInfo.BasePath = ""
r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))