关于gin-swagger隐藏models方法

原创

于 2025-03-03 16:27:26 发布 · 384 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#gin #golang

gin-swagger页面隐藏models

前言：

前言：

很多后端项目接口文档会用到swagger生成api文档，但是在注释中用object和自定义的struct时，swagger页面会展示models，这并不是很好看，下面就讲下如何隐藏

首先看仓库的文档

官方文档中的示例

// @title           Swagger Example API
// @version         1.0
// @description     This is a sample server celler server.
// @termsOfService  http://swagger.io/terms/

// @contact.name   API Support
// @contact.url    http://www.swagger.io/support
// @contact.email  support@swagger.io

// @license.name  Apache 2.0
// @license.url   http://www.apache.org/licenses/LICENSE-2.0.html

// @host      localhost:8080
// @BasePath  /api/v1

// @securityDefinitions.basic  BasicAuth

// @externalDocs.description  OpenAPI
// @externalDocs.url          https://swagger.io/resources/open-api/
func main() {
   
   
    r := gin.Default()

    c := controller.NewController()

    v1 := r.Group("/api/v1")
    {
   
   
        accounts := v1.Group("/accounts")
        {
   
   
            accounts.GET(":id", c.ShowAccount)
            accounts.GET("", c.ListAccounts)
            accounts.POST("", c.AddAccount)
            accounts.DELETE(":id", c.DeleteAccount)
            accounts.PATCH(":id", c.UpdateAccount)
            accounts.POST(":id/images", c.UploadAccountImage)
        }
    //...
    }
    r.GET("/swagger/*any", ginSwagger.WrapHan