在 flask 中支持多个 API 版本

Question

我开始使用 Flask 和 Python 设计一个 RESTful 网络服务，我想知道如何在同一个项目中支持多个 API 版本。我正在考虑将请求的 API 版本放在 URL 中，如下所示：

/myapp/v1/Users

一段时间后，我想在 API 的 1.1 版中添加另一个端点，并保留 v1 中未更改的所有内容：

/myapp/v1.1/Users   <= Same as in v1
/myapp/v1.1/Books

在 v2 中，"Users"-端点已更改：

/myapp/v2/Users   <= Changed in v2
/myapp/v2/Books   <= Same as in v1.1

等等...

查看 this 问题最简单的方法可能是这样的：

@app.route('/<version>/users')
def users(version):
    # do something
    return jsonify(response)

但我可以想象，随着每个新 API 版本的出现，这将变得更难维护。因此我想知道是否有更好的（=更容易维护和更好的结构）方法来使用 Flask 实现这一目标？

Answer 1

我是您所引用问题的公认答案的作者。我认为 /<version>/users 方法没有你说的那么有效。如果您必须管理三个或四个不同的版本，您最终会得到意大利面条代码。

我在那里提出的nginx idea更好，但是缺点是你必须托管两个独立的应用程序。那时我没有提到第三种选择，即为每个 API 版本使用一个蓝图。例如，考虑以下应用程序结构（为清楚起见大大简化）：

my_project
+-- api/
    +-- v1/
        +-- __init__.py
        +-- routes.py
    +-- v1_1/
        +-- __init__.py
        +-- routes.py
    +-- v2/
        +-- __init__.py
        +-- routes.py
    +-- __init__.py
    +-- common.py

这里有一个 api/common.py，它实现了 API 的所有版本都需要的通用功能。例如，您可以有一个辅助功能（未装饰为路由）来响应您的 /users 路由，该路由在 v1 和 v1.1 中是相同的。

每个 API 版本的 routes.py 定义路由，并在必要时调用 common.py 函数以避免重复逻辑。例如，您的 v1 和 v1.1 routes.py 可以有：

from api import common

@api.route('/users')
def get_users():
    return common.get_users()

注意 api.route。这里 api 是一个蓝图。将每个 API 版本实现为蓝图有助于将所有内容与正确的版本化 URL 结合起来。以下是将 API 蓝图导入应用程序实例的示例应用设置代码：

from api.v1 import api as api_v1
from api.v1_1 import api as api_v1_1
from api.v2 import api as api_v2

app.register_blueprint(api_v1, url_prefix='/v1')
app.register_blueprint(api_v1_1, url_prefix='/v1.1')
app.register_blueprint(api_v2, url_prefix='/v2')

这种结构非常好，因为它将所有 API 版本分开，但它们由同一个应用程序提供服务。作为一个额外的好处，当停止支持 v1 时，您只需删除对该版本的 register_blueprint 调用，从您的源代码中删除 v1 包，您就完成了。

现在，综上所述，您真的应该努力设计您的 API 以将不得不修改版本的风险降到最低。考虑到添加新路由不需要新的 API 版本，用新路由扩展 API 是完全没问题的。有时可以以不影响老客户的方式设计现有路线的变化。有时，修改 API 并不那么痛苦，并且可以更自由地进行更改，但理想情况下，这种情况不会经常发生。

Answer 2

如果它仍然相关我写了一个包来按版本管理端点您可以在 Git 上找到它 https://github.com/itay-bardugo/flask_version

在 flask 中支持多个 API 版本

Support multiple API versions in flask

python

flask