Flask 学习-52.Flask-RESTX 生成 Swagger 文档带上Authorization认证

上海-悠悠

发布于 2022-09-13 15:45:27

9430

发布于 2022-09-13 15:45:27

文章被收录于专栏：从零开始学自动化测试

前言

我们在开发的接口中，一般会带上用户登录的token认证，需在请求头部传Authorization。 Flask-RESTX 生成 Swagger 文档，可以直接在文档上登录，方便快速测试接口。

需登录认证的接口

接着前面一篇，需要登录的接口加上@jwt_required()装饰器

from flask_jwt_extended import jwt_required

@api.route('/')
class TodoList(Resource):
    '''Shows a list of all todos, and lets you POST to add new tasks'''
    @api.doc(description='接口描述，描述接口在什么场景使用 list_todos')
    @api.marshal_list_with(todo)
    @jwt_required()
    def get(self):
        '''List all tasks'''
        return DAO.todos

在 Swagger 文档中测试该接口

会返回401

接下来我们看下，如何在文档中全局登录，传token

添加Authorization

在apis/__init__.py文件中，实例化Api时候添加security参数

api = Api(
    title='yoyo API 接口文档',
    version='1.0',
    description='API 文档描述',
    security="Bearer Auth",
)

这时候文档中就会看到有锁的图标

接着再添加一个authorizations参数

api = Api(
    title='yoyo API 接口文档',
    version='1.0',
    description='API 文档描述',
    security="Bearer Auth",
    authorizations={
        "Bearer Auth": {
            "type": "apiKey",
            "in": "header",
            "name": "Authorization",
            "description": "Add a jwt with ** Bearer token"
        }
    }
)

于是在文档的右上角就会有个 Authorize 图标