Wie wird die Basis-URL in der Flask Restplus-Dokumentation angegeben?

Question

Könnten Sie bitte beschreiben, wie Sie die Basis-URL in der von Flask Restplus automatisch generierten Dokumentation angeben?

Ich verwende den folgenden Code, aber nichts zeigt in der Prahlerei UI up:

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

standardmäßig, wenn dieses Muster unter Verwendung von (. Dh mit app als Konstruktorargument), die API ist auf dem Wurzel-Endpunkt (dh. /) und die Swagger-Dokumentation ist auf der API-Wurzel (dh. immer noch /).

Sie haben mehrere Möglichkeiten:

Verwenden Sie einen Plan der API-Wurzel

zu ändern Wenn Sie die Dokumentation auf der API-Wurzel halten wollen, aber die API-Wurzel ändern, use a blueprint Sie API zu registrieren, wo Sie wollen.

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/' 

nur der Dokumentation ändern Ort

Wenn Sie die API Wurzel an der gleichen Stelle halten wollen, aber nur in der Dokumentation Position verschieben, Flask-restplus können Sie es mit dem doc Parameter angeben.

from flask import Flask 
from flask_restplus import Api 

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

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

Sie können auch beide kombinieren. Weitere Informationen zur erweiterten Anpassung der Dokumentation finden Sie unter http://flask-restplus.readthedocs.io/en/stable/swagger.html#customization.