Django Rest Framework - 版本流程

通过参数传递版本号

a. 通过url路径传参

1
from rest_framework.versioning import URLPathVersioning

b. url中通过GET传参

1
from rest_framework.versioning import QueryParameterVersioning

1 在URL路径中传参(推荐使用)

  1. 在settting中定义版本参数,有四个,一个全局的版本功能对象,一个默认的版本,一个允许的版本(如果是不允许的版本,会返回错误),一个传递的参数名称。
1
2
3
4
5
6
REST_FRAMEWORK = {
"DEFAULT_VERSIONING_CLASS":"rest_framework.versioning.QueryParameterVersioning", # 设置全局版本功能
"DEFAULT_VERSION":"v1", # 默认的版本
"ALLOWED_VERSIONS":['v1', 'v2'], # 允许的版本
"VERSION_PARAM":"version", # 传递的参数名
}
  1. 在urls中定义要传递的版本名称:

外层路由做分发

1
2
3
4
5
6
7
8
from django.contrib import admin
from django.conf.urls import url, include
from django.urls import path

urlpatterns = [
url(r'^api/', include('api.urls')),
]

APP层路由实现业务

1
2
3
urlpatterns = [
re_path(r'^(?P<version>v\d)/users/$', views.UserView.as_view(), name='user'),
]
  1. 因为是全局设置,所以视图中不用设置也可以
1
2
3
4
5
class UserView(APIView):
def get(self, request, *args, **kwargs):
print(request.version)
print(request.versioning_scheme.reverse(viewname="user", request=request))
return HttpResponse('用户列表')
  1. 效果:
1
http://127.0.0.1:8000/api/v1/users/ # OK
1
2
3
4
5
http://127.0.0.1:8000/api/v3/users/

{
"detail": "Invalid version in URL path."
}

2 URL中通过GET传参(不推荐)

  1. 在settting中定义版本参数,有三个,一个默认的版本,一个允许的版本(如果是不允许的版本,会返回错误),一个传递的参数名称。
1
2
3
4
5
REST_FRAMEWORK = {
"DEFAULT_VERSION":"v1", # 默认的版本
"ALLOWED_VERSIONS":['v1', 'v2'], # 允许的版本
"VERSION_PARAM":"version", # 传递的参数名
}
  1. 在视图views中填入 versioning_class 类参数(request.version是返回的参数结果)
1
2
3
4
5
6
7
from rest_framework.versioning import QueryParameterVersioning
class Version(APIView):
versioning_class = QueryParameterVersioning
def get(self, request, *args, **kwargs):
print(request.version) #返回的版本结果
print(request.versioning_scheme) # 版本对象,这里的对象是QueryParameterVersioning
return JsonResponse({"x":'x'})
  1. 结果如图
1
http://127.0.0.1:8000/api/users/?version=v1