rest-framework之版本控制

rest-framework之版本控制

作用：用于版本控制

内置的版本控制类

from rest_framework.versioning import QueryParameterVersioning,AcceptHeaderVersioning,NamespaceVersioning,URLPathVersioning

#基于url的get传参方式：QueryParameterVersioning------>如：/users?version=v1
#基于url的正则方式：URLPathVersioning------>/v1/users/
#基于 accept 请求头方式：AcceptHeaderVersioning------>Accept: application/json; version=1.0
#基于主机名方法：HostNameVersioning------>v1.example.com
#基于django路由系统的namespace：NamespaceVersioning------>example.com/v1/users/

全局使用

在setting中进行配置

'DEFAULT_VERSIONING_CLASS':'rest_framework.versioning.URLPathVersioning',
			'DEFAULT_VERSION': 'v1',  # 默认版本(从request对象里取不到，显示的默认值)
			'ALLOWED_VERSIONS': ['v1', 'v2'],  # 允许的版本
			'VERSION_PARAM': 'version'  # URL中获取值的key

配置后的路由需要修改

-url(r'^(?P<version>[v1|v2]+)/test/', views.Test.as_view()),

在视图类中就可以通过：request.version取出当前访问哪个版本，相应的取执行相应版本的代码

局部使用

在视图类中

#在CBV类中加入
versioning_class = URLPathVersioning

源码分析

#执行determine_version，返回两个值，放到request对象里
version, scheme = self.determine_version(request, *args, **kwargs)
request.version, request.versioning_scheme = version, scheme

def determine_version(self, request, *args, **kwargs):
        #当配置上版本类之后，就会实例化
        if self.versioning_class is None:
            return (None, None)
        scheme = self.versioning_class()
        return (scheme.determine_version(request, *args, **kwargs), scheme)