提供了编程的基础技术教程

zl程序教程

您现在的位置是：首页 >  其他

当前栏目

Flask 学习-46.Flask-RESTX 生成 Swagger 文档入门教程

文档学习入门教程 生成 Flask swagger 46 RESTX
2023-06-13 09:12:28 时间

前言

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

Swagger UI 文档

默认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/<id>')
@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)

运行上面的代码并访问 API 的根 URL ( http://localhost:5000 )，您可以查看自动生成的 Swagger UI 文档。

点开详情可以看到参数的描述

doc 文档路径

您可以使用参数控制 Swagger UI 路径doc（默认为 API 根目录）：

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',
          doc='/doc'      # swagger 文档访问地址
)

那么Swagger UI访问地址是http://127.0.0.1:5000/doc

禁用文档

要完全禁用 Swagger UI，请设置doc=False：

from flask import Flask
from flask_restx import Api

app = Flask(__name__)
api = Api(app, doc=False)

2022年第 12期《python接口web自动化+测试开发》课程，9月17号开学!

本期上课时间：2022年9月17号 - 2022年12月17号，周六周日上午9:00-11:00

报名费：报名费3000一人（周期3个月）

联系微信/QQ：283340479

相关文章