swagger 解析不出来Api

1. 运行环境

go1.16.4 linux/amd64

github.com/swaggo/files v0.0.0-20210815190702-a29dd2bc99b2
github.com/swaggo/gin-swagger v1.3.3
github.com/swaggo/swag v1.7.4

2. 问题描述?

swagger 解析不出来我的api

swagger 解析不出来Api

main.go

func main(){
...
router := routers.NewRouter()
...
}

router.go

import (
  ...
  swaggerFiles "github.com/swaggo/files"
  ginSwagger "github.com/swaggo/gin-swagger"
  _ "webSocket/docs"
...
 )
func NewRouter() *gin.Engine {
...
    // api
    r := NewApiRouter()
    return r
}

func NewApiRouter() *gin.Engine {
...
   // 接口文档
  r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
   // 获取token
  r.POST("/auth", api.GetAuth)
...

   return r
}

auto.go


// @Summary 获取token
// @Produce json
// @Param app_key body string true "app_key"
// @Param app_secret body string true  "app_secret"
// @Success 200 {string} string "成功"
// @Failure 500 {string}  string "内部错误"
// @Router /auth [post]

func GetAuth(c *gin.Context){
...

}

3. 您期望得到的结果?

swagger 解析不出来Api

4. 您实际得到的结果?

swagger 解析不出来Api

讨论数量: 1

问题已解决, 注释是不能空行的。

// @Summary 获取token
// @Produce json
// @Param app_key body string true "app_key"
// @Param app_secret body string true  "app_secret"
// @Success 200 {string} string "成功"
// @Failure 500 {string}  string "内部错误"
// @Router /auth [post]
func GetAuth(c *gin.Context){
    ...

}
2年前 评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!