python - 支持flask中的多个API版本

Question

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

/myapp/v1/Users

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

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

在 v2 中，“用户”端点发生了变化:

/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 想法更好，但缺点是您必须托管两个单独的应用程序。那时我没有提到第三种选择，即为每个 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 中相同的路由。

routes.py为每个 API 版本定义路由，并在必要时调用 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 并有更多的自由来更改内容并没有那么痛苦，但理想情况下这种情况不会经常发生。