如何在 Flask Restplus 文档中指示基数 url

Question

能否请您描述如何在 Flask Restplus 自动生成的文档中指明基数 URL？

我是运行下面的代码但是在swagger中什么也没有显示UI:

from flask import Flask
from flask_restplus import Api

app = Flask(__name__)
api = Api(app,
    title='Data Quality Framework API',
    version='v0.1',
    doc='/data_quality_framework/api/documentation',
    contact='me@xxx.com',
    base_url='/test')

Answer 1

默认情况下，当使用此模式时（即使用 app 作为构造函数参数），API 在根端点（即 /）和 swagger 文档在 API 根上（即仍然 /）。

你有多种可能性：

使用蓝图更改API根目录

如果您想在 API 根目录下保留文档但更改 API 根目录，use a blueprint 以在您想要的地方注册您 API。

from flask import Flask, Blueprint
from flask_restplus import Api

app = Flask(__name__)
blueprint = Blueprint('api', __name__, url_prefix='/test')
api = Api(blueprint)
app.register_blueprint(blueprint)

assert url_for('api.doc') == '/test/'

仅更改文档位置

如果您想将 API 根目录保留在同一位置，但只移动文档位置，Flask-restplus 允许您使用 doc 参数指定它。

from flask import Flask
from flask_restplus import Api

app = Flask(__name__)
api = Api(app, doc='/test/')

assert url_for('doc') == '/test/'

您也可以将两者结合起来。有关高级文档自定义的更多详细信息，请参阅 http://flask-restplus.readthedocs.io/en/stable/swagger.html#customization。

Answer 2

添加行

from flask import url_for

Answer 3

您可以使用 prefix 参数来定义它。我已经在 0.13.0 版本上试过了。

from flask import Flask
from flask_restplus import Api

app = Flask(__name__)
api = Api(app, prefix='/api')

如何在 Flask Restplus 文档中指示基数 url

How to indicate base url in Flask Restplus documentation

flask

swagger-ui

flask-restplus