源码流程
- 和认证的流程一样，进入initial(request)
在认证，权限，节流前先执行了这两句函数,获取到version,scheme，并分别赋值给request对象的version, versioning_scheme属性
# 获取版本(version)和scheme
version, scheme = self.determine_version(request, *args, **kwargs)
request.version, request.versioning_scheme = version, scheme
进入determine_version()函数
scheme = self.versioning_class()
return (scheme.determine_version(request, *args, **kwargs), scheme)
在这里获取到scheme就是api_settings.DEFAULT_VERSIONING_CLASS,系统默认版本控制类，那scheme.determine_version(request, *args, kwargs) 就是该类下的一个方法
查看rest_framework库的一个自带类中的determine_version方法
class QueryParameterVersioning(BaseVersioning):
"""
GET /something/?version=0.1 HTTP/1.1
Host: example.com
Accept: application/json
"""
invalid_version_message = _('Invalid version in query parameter.')
def determine_version(self, request, *args, **kwargs):
version = request.query_params.get(self.version_param, self.default_version)
if not self.is_allowed_version(version):
raise exceptions.NotFound(self.invalid_version_message)
return version
返回的是版本号。于是version, scheme分别是版本号和一个版本控制类，并分别赋值给request对象的version, versioning_scheme属性。
使用
- 定义一个版本类，重写determine_version方法，返回版本号
class ParamVersion(object):
def determine_version(self, request, *args, **kwargs):
version = request.query_params.get('version')
return version
- 局部使用
相关业务
class UsersView(APIView):
versioning_class = ParamVersion
def get(self, request, *args, **kwargs):
# 获取版本
self.dispatch
print(request.version)
# 获取版本处理对象
# print(request.versioning_scheme)
# u1 = request.versioning_scheme.reverse('api:uuu', request=request)
# print("u1:", u1)
# u2 = reverse('api:uuu', kwargs={'version': 1})
# print("u2:", u2)
return HttpResponse('用户列表')
- 全局使用
'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.URLPathVersioning', # 默认版本类
'DEFAULT_VERSION': 'v1', # 默认版本
'ALLOWED_VERSIONS': ['v1', 'v2'], # 允许的版本
'VERSION_PARAM': 'version' ，# URL中获取值的key
}
内置类的使用
- 放到url后作为get参数
http://127.0.0.1:8000/api/users/?version=v1
from rest_framework.versioning import QueryParameterVersioning
class UsersView(APIView):
versioning_class = QueryParameterVersioning
def get(self, request, *args, **kwargs):
# 获取版本
self.dispatch
print(request.version)
# 获取版本处理对象
# print(request.versioning_scheme)
# u1 = request.versioning_scheme.reverse('api:uuu', request=request)
# print("u1:", u1)
# u2 = reverse('api:uuu', kwargs={'version': 1})
# print("u2:", u2)
return HttpResponse('用户列表')
- 用正则匹配
re_path(r'^(?P<version>[v1|v2]+)/users/', views.UsersView.as_view(), name="uuu"),
from rest_framework.versioning import URLPathVersioning
class UsersView(APIView):
versioning_class = URLPathVersioning
def get(self, request, *args, **kwargs):
# 获取版本
self.dispatch
print(request.version)
# 获取版本处理对象
# print(request.versioning_scheme)
# u1 = request.versioning_scheme.reverse('api:uuu', request=request)
# print("u1:", u1)
# u2 = reverse('api:uuu', kwargs={'version': 1})
# print("u2:", u2)
return HttpResponse('用户列表')
request.versioning_scheme.reverse方法可以获取路由，是drf中的方法
django.urls.reverse 是django中的反向获取路由方法
u1: http://127.0.0.1:8000/api/v1/users/
u2: /api/1/users/
