beego API自动化文档详细参数

oauth2方式没太搞明白scopes参数作用， 其他可以参考bee\generate\swaggergen\g_docs.go文件的GenerateDocs函数

router.go

// @APIVersion 1.0.0(版本号)
// @Title test API(标题)
// @Description 测试API.(文档描述)
// @Contact zerobyte@88.com(联系邮箱)
// @Schemes http,https(可使用的请求方式)
// @Host 127.0.0.1:9090(域名)
// @Name ZeroByte(联系人)
// 安全验证 分组名 类型[apiKey,oauth2,basic](可以多个)
// @SecurityDefinition token1 apiKey token header
// (token1分组名 apiKey类型 token参数键名 header传递类型,apiKey时只有header、query)
// @SecurityDefinition token3 apiKey x-api-key query
// @SecurityDefinition 分组名 oauth2 AuthorizationURL Flow scopes
// @SecurityDefinition 分组名 basic "备注说明"

"securityDefinitions": {
        "basic": {
            "type": "basic",
            "description": "备注说明"
        },
        "oauth": {
            "type": "oauth2",
            "flow": "implicit",
            "authorizationUrl": "https://petstore.swagger.io/oauth/authorize",
            "scopes": {
                "read": "write"
            }
        },
        "token1": {
            "type": "apiKey",
            "name": "token",
            "in": "header"
        },
        "token3": {
            "type": "apiKey",
            "name": "x-api-key",
            "in": "header"
        }
    }

模块文件

// @Title 标题（显示在url中）
// @Summary 摘要
// @Description 描述
// 参数        参数名    请求类型[query,header,path,formData,body]   参数类型[string,number,integer,boolean,array,file]   是否必须    "注释"
// @Param    username    query     string     false     "用户名"
// @Param    password    query     string     false     "密码"
// @Success 200 {object} models.admin
// @Failure 400 no enough input
// @Failure 500 get products common error
// 路由 请求地址（最后一级 /v1/admin/login） 请求类型多个用逗号
// @router /login [get]
// 返回格式
// @Accept json,xml
// @Security token1(验证方式分组名，多个用逗号)