【DRF版本控制】Python中第三方库rest_framework的用法

匿名 (未验证) 提交于 2019-12-02 22:11:45
版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/qq_41964425/article/details/84143998

首先,我们开发的项目会有多个版本.
其次,我们的项目版本会随着更新越来越多,我们不可能因出了新版本就不维护旧版本了.
那么,我们就需要对版本进行控制――DRF版本控制.


源码剖析

DRF视图中的APIView返回的是View类中的view函数,然后调用dispatch方法.

那么,我们来看看dispatch方法都做了些什么:

执行self.initial方法之前是各种赋值,包括request的重新封装赋值.

self.initial方法中有路由的分发,我们再来看下此方法具体都做了些什么:

我们可以看到:
version版本信息赋值给了request.version.
scheme版本控制方案赋值给了request.versioning_scheme.

其实合格版本控制方法就是我们配置的版本控制的类.
也就是说,APIView通过这个方法初始化自己提供的组件.

我们接下来看看rest_framework为我们提供了那些版本控制的方法(在from rest_framework import versioning文件内):

如上,rest_framework为我们提供的所有版本控制的方法.

下面,我们来看看在URL上携带版本信息的用法.


使用内置的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()), ] 

步骤三 视图

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 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()), ] 

步骤四 视图

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的信息") 

测试效果如下图:



is ok.



易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!