如何调整flasgger以便在发送请求时使用基本身份验证

时间:2017-08-02 16:56:40

标签: authentication flask basic-authentication flasgger

我尝试将flasgger用于我的简单RESTful API。 API需要身份验证/授权,并使用基本身份验证来执行任何查询。

swagger.io中有关于基本身份验证的非常好的文档 但是如何在flassger中实现这些设置呢?我曾尝试使用模板将securityDefinitions设置为swaggler,但尝试尚未成功。

UPD。可能这个问题还没有得到解决。 Flasgger doesnt support basic auth #103

2 个答案:

答案 0 :(得分:0)

我已经解决了添加下一个代码的身份验证问题:

swagger_template = {
    # Other settings

    'securityDefinitions': {
        'basicAuth': {
            'type': 'basic'
        }
    },

    # Other settings
}

app = Flask(__name__)
Swagger(app, swagger_config, template=swagger_template)

答案 1 :(得分:0)

感谢Dimaf的回答,对我有很大帮助。只是想更新新版本,以防其他人遇到相同的问题。

对于Swagger 3.0,配置已更新为以下内容(此示例用于承载授权):

swagger_template = {
    "components": {
        "securitySchemes": {
            "BearerAuth": {
                "type": "http",
                "scheme": "bearer",
                "bearerFormat": "JWT",
                "in": "header",
            }
        }
    }
}