Flask 学习-51.Flask-RESTX 生成 Swagger 文档 详细教程

前言

Swagger API 文档是自动生成的，可从您的 API 的根 URL 获取。@api.doc()您可以使用装饰器配置文档。

基本配置

默认flask-restx提供 Swagger UI 文档，从 API 的根 URL 提供

from flask import Flask
from flask_restx import Api, Resource, fields

app = Flask(__name__)
api = Api(app, version='1.0', title='Sample API',
    description='A sample API',
)

@api.route('/my-resource/')
@api.doc(params={'id': 'An ID'})
class MyResource(Resource):
    def get(self, id):
        return {}

    @api.response(403, 'Not Authorized')
    def post(self, id):
        api.abort(403)


if __name__ == '__main__':
    app.run(debug=True)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

基础教程参考前面这篇https://www.cnblogs.