源碼流程
- 和認證的流程一樣,進入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/