如何实现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元类
通过本文，将深入讨论Python元类，其属性，如何以及何时在Python中使用元类。
2021-05-05
python中json操作之json.loads、json.load、json.jumps及json.jump用法
最近在python里面用json读取json文件,可是老是不成功,特此记录一下,下面这篇文章主要给大家介绍了关于python中json操作之json.loads、json.load、json.jumps及json.jump用法的相关资料,需要的朋友可以参考下
2022-08-08
python networkx 包绘制复杂网络关系图的实现
这篇文章主要介绍了python networkx 包绘制复杂网络关系图的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-07-07
OpenCV3.0+Python3.6实现特定颜色的物体追踪
这篇文章主要为大家详细介绍了OpenCV3.0+Python3.6实现特定颜色的物体追踪，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-07-07
Python3.7 基于 pycryptodome 的AES加密解密、RSA加密解密、加签验签
这篇文章主要介绍了Python3.7 基于 pycryptodome 的AES加密解密、RSA加密解密、加签验签，本文通过实例代码给大家介绍的非常详细,需要的朋友可以参考下
2019-12-12
Python使用Pygame绘制时钟
这篇文章主要为大家详细介绍了Python使用Pygame绘制时钟，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2020-11-11
Python 照片人物背景替换的实现方法
本文主要介绍了如何通过Python实现照片中人物背景图的替换，甚至可以精细到头发丝，感兴趣的小伙伴可以看看
2021-11-11
python中操作文件的模块的方法总结
在本篇文章里小编给大家整理的是一篇关于python中操作文件的模块的方法总结，有需要的朋友们可以学习参考下。
2021-02-02
如何在scrapy中捕获并处理各种异常
这篇文章主要介绍了如何在scrapy中捕获并处理各种异常，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-09-09
python dataframe获得指定行列实战代码
对于一个DataFrame,常常需要筛选出某列为指定值的行,下面这篇文章主要给大家介绍了关于python dataframe获得指定行列的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
2023-12-12