第十章 restframework——版本控制

第十章 restframework——版本控制

一、内置的版本控制类

二、局部使用

三、全局使用

四、源码解析

一、内置的版本控制类

导入模块

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

1.QueryParameterVersioning

作用：

基于url的get传参方式

地址访问举例：

/users?version=v1

2.AcceptHeaderVersioning

作用：

基于 accept 请求头方式

地址访问举例：

Accept: application/json; version=1.0

3.NamespaceVersioning

作用：

基于django路由系统的namespace

地址访问举例：

example.com/v1/users/

4.URLPathVersioning

作用：

基于url的正则方式

地址访问举例：

/v1/users/

urls.py

from django.conf.urls import url, include
from web.views import TestView

urlpatterns = [
    url(r'^(?P<version>[v1|v2]+)/test/', TestView.as_view(), name='test'),
]

views.py

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.versioning import URLPathVersioning


class TestView(APIView):
    versioning_class = URLPathVersioning

    def get(self, request, *args, **kwargs):
        # 获取版本
        print(request.version)
        # 获取版本管理的类
        print(request.versioning_scheme)

        # 反向生成URL
        reverse_url = request.versioning_scheme.reverse('test', request=request)
        print(reverse_url)

 　　　　# 基于django内置,反向生成url
        # from django.urls import reverse
        # url2=reverse(viewname='ttt',kwargs={'version':'v2'})
        # print(url2)

return Response('GET请求，响应内容')

5.HostNameVersioning

作用：

基于主机名方法

地址访问举例：

v1.example.com

二、局部使用

#在CBV类中加入
versioning_class = URLPathVersioning

三、全局使用

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

四、源码解析

#执行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)