Flask 使用 url 参数路由到不同的 API 端点

Question

我正在 Flask 中开发 API，其中一项要求是保留多个版本，以便最终用户能够在版本之间切换。我已经开始根据的推荐（或回答）维护多个版本代码库，但我的问题是，是否有任何方法可以让用户根据参数选择不同的 API 版本在没有实际改变 url 的情况下传入。

例如：

http://testapp.com/api?v=1.0

将路由到

http://testapp.com/1.0/api

和

http://testapp.com/api?v=2.0

将路由到

http://testapp.com/2.0/api

我知道使用 redirect(url_for('###')) 和注册的蓝图可能可以解决这个问题，但在我的情况下并不理想（我想保持相同的 url 而不是重定向但呈现来自不同的响应api 的版本相应地进入当前请求）

如果我写的不清楚，请提前致歉。

Answer 1

您仍然可以使用视图函数，而不是重定向到另一条路由，只需调用视图函数即可。

例如：

from flask import request

from my_app.api.v1.views import index as v1_index
from my_app.api.v2.views import index as v2_index

.... other code ...


@app.route('/api')
def index():
    api_version = request.args.get('v', '1.0')
    if api_version == '1.0':
        return v1_index()
    elif api_version == '2.0':
        return v2_index()
    else:
        return 'Unsupported API version.'

Answer 2

您可以在 Flask 应用程序中通过在每个请求之前检查请求 url 来执行此操作。

您可以使用 flask before_request 装饰器在每个请求之前运行代码。

下面的代码将按照您的意愿重定向 urls

from flask import Flask, request, redirect, url_for
app = Flask(__name__)

@app.before_request
def check_url_and_redirect():
    if request.path[1:] == 'api':
        if request.args.get('v') == "1.0":
            return redirect(url_for('v1'))
        elif request.args.get('v') == "2.0":
            return redirect(url_for('v2'))

@app.route("/")
def hello():
    return "Hello World!"

@app.route("/1.0/api")
def v1():
    return "This is V1"

@app.route("/2.0/api")
def v2():
    return "This is V2"

if __name__ == "__main__":
    app.run(debug=True)

Flask 使用 url 参数路由到不同的 API 端点

Flask using url parameter to route to different API endpoint

python

versioning

api

flask