1:在 go packages 网站中找到 gin-swagger 并打开他
https://pkg.go.dev/github.com/swaggo/gin-swagger#section-readme
2:安装
go的版本 <1.1.7
go get -u github.com/swaggo/swag/cmd/swag
go的版本 > 1.1.7
go install github.com/swaggo/swag/cmd/swag
接着运行
swag init
如果报如下错误,还请查看go的版本,再选择对应的安装语句操作一次
3:在router包下面进行swagger的相应操作,如果import的包报错,根据编辑器提示引入即可
import (
"ginchat/server/docs"
"ginchat/server/service"
"github.com/gin-gonic/gin"
swaggerfiles "github.com/swaggo/files"
ginSwagger "github.com/swaggo/gin-swagger"
)
func Router() *gin.Engine {
r := gin.Default()
// 重要
docs.SwaggerInfo.BasePath = ""
r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))
r.GET("/index", service.GetIndex)
return r
}
4:在server 层进行注解说明
// index
// @Tags 测试
// @Accept json
// @Produce json
// @Success 200 {string} welcome
// @Router /index [get]
func GetIndex(c *gin.Context) {
c.JSON(200, gin. H{
"message": "请求成功",
"success": true,
})
}