云起工作室 15711107967
11_swagger接口文档
2025-02-06 10:37:43
go get -u github.com/swaggo/gin-swagger


go get -u github.com/swaggo/files


初始化文档 swag init

无法识别swag 命令 执行:go install github.com/swaggo/swag/cmd/swag


在main 中引入

swaggerFiles "github.com/swaggo/files"
ginSwagger "github.com/swaggo/gin-swagger"
"net/http"
_ "testSwagger/docs"


注释

// @title API文档
// @version 1.0
// @description api文档呀
// @host localhost 8085
// @BasePath /
func main(){
  app := gin.Default()

  //app.GET("/swagger/*any", gs.WrapHandler(swaggerFiles.Handler))

  //设置密码访问
  authorized := app.Group("/swagger", gin.BasicAuth(gin.Accounts{
     "username": "password",
  }))
  authorized.GET("/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))

  app.Run()
}


接口注释: 不会因为 跨文件而读取不到
// @Tags 用户管理
// @Summary 用户详情
// @Description 返回一个用户列表
// @Param limit query string false "返回多少条"
// @Router /api/userdetail [get]
// @Success 200 {object} string




访问 ip:端口/swagger/index.html