我是你所提及问题的被接受答案的作者。我认为这种/<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的痛苦会较小,而拥有更改事物的更多自由,但是理想情况下,这种情况不会经常发生。