脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 脚本专栏 → python → Django Rest framework版本控制

如何实现Django Rest framework版本控制

 更新时间：2019年07月25日 15:56:49   作者：Title  
这篇文章主要介绍了如何实现Django Rest framework版本控制,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

前言

首先，我们开发的项目会有多个版本.

其次，我们的项目版本会随着更新越来越多，我们不可能因出了新版本就不维护旧版本了.

那么，我们就需要对版本进行控制——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()),
]

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

测试效果如下图：




is ok.

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

相关文章

  • Python使用random.shuffle()随机打乱字典排序

    Python使用random.shuffle()随机打乱字典排序

    本文主要介绍了Python使用random.shuffle()随机打乱字典排序，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2022-08-08
  • Python双向循环链表实现方法分析

    Python双向循环链表实现方法分析

    这篇文章主要介绍了Python双向循环链表,结合实例形式分析了Python双向链表的定义、遍历、添加、删除、搜索等相关操作技巧,需要的朋友可以参考下
    2018-07-07
  • python实现手机通讯录搜索功能

    python实现手机通讯录搜索功能

    这篇文章主要介绍了python模仿手机通讯录搜索功能，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2018-02-02
  • Python与C语言分别解决完全平方数问题

    Python与C语言分别解决完全平方数问题

    完全平方数指用一个整数乘以自己例如1*1.2*2.3*3等依次类推，若一个数能表示成某个整数的平方的形式，则称这个数为完全平方数。完全平方数是非负数，而一个完全平方数的项有俩个，让我们用程序来练习一下
    2022-03-03
  • python中print的不换行即时输出的快速解决方法

    python中print的不换行即时输出的快速解决方法

    下面小编就为大家带来一篇python中print的不换行即时输出的快速解决方法。小编觉得挺不错的，现在就分享给大家，也给大家做个参考
    2016-07-07
  • Python中优化NumPy包使用性能的教程

    Python中优化NumPy包使用性能的教程

    这篇文章主要介绍了Python中优化NumPy包使用性能的教程,包括内存和拷贝等方面,需要的朋友可以参考下
    2015-04-04
  • python统计字符的个数代码实例

    python统计字符的个数代码实例

    在本篇文章里小编给大家整理了关于python统计字符的个数代码实例内容，需要的朋友们可以参考下。
    2020-02-02
  • django限制匿名用户访问及重定向的方法实例

    django限制匿名用户访问及重定向的方法实例

    这篇文章主要给大家介绍了关于django限制匿名用户访问及重定向的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧。
    2018-02-02
  • python中的位置参数和关键字参数详解

    python中的位置参数和关键字参数详解

    位置参数和关键字参数是 Python 中的两种不同类型的函数参数传递方式,位置参数依赖于参数的位置顺序,而关键字参数通过参数名传递,不受位置影响,本文通过代码示例给大家详细介绍了python中的位置参数和关键字参数,需要的朋友可以参考下
    2023-12-12
  • Python类的继承和多态代码详解

    Python类的继承和多态代码详解

    这篇文章主要介绍了Python类的继承和多态代码详解，具有一定借鉴价值,需要的朋友可以参考下
    2017-12-12

最新评论