3:Django-DRF-版本控制

版本控制

开发项目的时候会有多个版本，当我们项目越来越新，版本越来越多，我们不可能新的版本出来了旧的版本就不维护了，所以我们需要对版本进行控制，

这个DRF也给我们提供了一些封装好的版本控制方法.

一：使用内置的URLPathVersioning类(推荐)

URLPathVersioning是在url上携带版本信息的方法.

步骤一 setting.py

REST_FRAMEWORK = {
    'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.URLPathVersioning',  # 指定使用的版本控制类
    'ALLOWED_VERSIONS': ['v1', 'v2'],  # 允许的版本
    'VERSION_PARAM': 'version',  # 版本使用的参数名称
    'DEFAULT_VERSION': 'v1',  # 默认使用的版本
}

步骤二 urls.py

from django.conf.urls import url
from blog.views import Test01View  # 导入视图
 
urlpatterns = [
    # 如下路径形式：
    url(r'^(?P<version>[v1|v2]+)/test01', Test01View.as_view()),
    url(r'^(?P<version>[v1|v2]+)/users/$', views.UsersView.as_view(),name='uuu'),
]

步骤三 views.py

from rest_framework.views import APIView
from rest_framework.response import Response
 
class Test01View(APIView):
    def get(self, request, *args, **kwargs):
        print("版本：", kwargs['version'])
        print("版本控制信息：", request.versioning_scheme)
        if request.version == 'v1':
            # 处理版本v1的业务逻辑
            return Response("这是版本v1的信息")
        # 处理版本v2的业务逻辑
        return Response("这是版本v2的信息")
    
class UsersView(APIView):
    def get(self, request, *args, **kwargs):、
        #获取版本
        print(request.version)                
        # 2. 获取处理版本的对象
        print(request.versioning_scheme)
        # 3. 反向生成URL（rest framework）
        u1 = request.versioning_scheme.reverse(viewname='uuu', request=request)
        print(u1)
        # 4. 反向生成URL
        u2 = reverse(viewname='uuu', kwargs={'version': 2})
        print(u2)
        return HttpResponse('用户列表')

'''rest框架提供的版本控制类，其中有5个类可以调用包含：host头携带版本、协议头携带版本、路由携带、namespace携带'''

二：使用自定义的版本控制类

步骤一 创建自定义版本控制类

class MyVersion():
    def determine_version(self, request, *args, **kwargs):
        # 返回值是版本号
        # 获取前端传过来的版本号 并且把版本号返回
        version = request.query_params.get('version')
        if not version:
            # 默认为版本v1，否则都为版本v2
            version = 'v1'
        return version

步骤二 setting.py

REST_FRAMEWORK = {
    'DEFAULT_VERSIONING_CLASS': 'utils.version.MyVersion',  # 指定自定义的版本控制类
    'ALLOWED_VERSIONS': ['v1', 'v2'],  # 允许的版本
    'VERSION_PARAM': 'version',  # 版本使用的参数名称
    'DEFAULT_VERSION': 'v1',  # 默认使用的版本
}

步骤三 urls.py

from blog.views import Test02View  # 导入视图
 
urlpatterns = [
    # 如下路径格式
    url(r'^test02/$', Test02View.as_view()),
]

步骤四 views.py

from rest_framework.views import APIView
from rest_framework.response import Response
 
class Test02View(APIView):
    def get(self, request):
        print("版本：", request.version)
        print("版本控制信息：", request.versioning_scheme)
        if request.version == 'v2':
            # 处理版本v2的业务逻辑
            return Response("这是版本v2的信息")
        # 处理版本v1的业务逻辑
        return Response("这是版本v1的信息")