如何实现Django Rest framework版本控制
作者:Title 发布时间:2022-10-30 02:29:19
前言
首先,我们开发的项目会有多个版本.
其次,我们的项目版本会随着更新越来越多,我们不可能因出了新版本就不维护旧版本了.
那么,我们就需要对版本进行控制——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.
来源:https://www.cnblogs.com/zyk01/p/10176373.html
猜你喜欢
- FCKeditor至今已经到了2.3.1版本了,对于国内的WEB开发者来说,也基本上都已经“闻风知多少”了,很多人将其融放到自己的项目中,更
- 一、Matplotlib 绘图在数据分析中,数据可视化也非常重要,通过直观的展示过程、结果数据,可以帮助我们清晰的理解数据,进而更好的进行分
- 导航设计是结构层面设计中的主要工作之一,在软件中,导航设计的好坏,直接关系到用户使用是否能够流畅。面对较复杂的导航,我们第一反应是将其简化。
- 本文实例讲述了php面象对象数据库操作类。分享给大家供大家参考。具体实现代码如下://此处构造一个数据库操作类,封装所有数据库操作 //可以
- 题目:用 JavaScript 代码实现空位补零,比如 pad(12, 3) => 012实现一:/* 平淡无奇法 */functio
- 现在jquery应用的越来越多, 有些同学在享受爽快淋漓coding时就将性能问题忽略了, 比如我. jquery虽
- 鉴于上一篇中最后三个问题:1、上述程序是否能进行优化(比如功能相同的)2、创建三个3个实例,用了3个语句,能否建一个函数,只输入一个数n,就
- PyType_Type和PyBaseObject_TypePyObject和PyTypeObject内容的最后指出下图中对实例对象和类型对象
- 产品通常分两种,一种是遵循现有用户习惯,一种是颠覆用户习惯。至于什么是用户习惯,你现在用右手还是左手操作鼠标,这就是你的习惯。很多公司团队专
- 自己做了一个asp页面,用了一个td来显示留言本的最新消息;但是却无法控制其排版问题,因为该td的width确定,但是数据库中的文字却是未知
- 多进程&多线程服务端:多进程和多线程的开启方式相同。缺点:<1> 由于Cpython的GIL,导致同一时间无法运行多个线
- SQL Server与Oracle、DB2的优劣对比:1.开放性:SQL Server只能在Windows上运行,没有丝毫的开放性,操作系统
- 问题:如何保护自己的ASP源代码不泄露? 答:下载微软的Windows Script Encoder,对ASP的脚本和客户端javascri
- 计算机一般来说是需要定期的清理,系统的内存不能无限延伸,同时有一些不需要的文件也可以得以清除掉。有些人会使用os.remove来进行文件的清
- 1、运算概念的理解运算(Operation)是操作逻辑的抽象运算体现一种操作逻辑,在广义角度来说任何程序都是一种运算Python解释器通过保
- 在查看MySQL对文件的操作中,它在不同的操作系统上对文件的操作,除了使用标准C运行库函数,包括open、close、seek等,在Win3
- 使用ASP实现网站的目录树数据库结构(共使用了两个表)1。tblCategory字段名 类型 Root&
- 此系列意在记录于一些有趣的程序及对其的总结。问题来源:https://github.com/Yixiaohan/show-me-the-co
- 一、制作播放器的思路制作一个多功能音乐播放器的思路确定播放器的需求和功能,例如支持哪些音频格式、播放列表管理、循环播放、暂停、进度条显示等等
- 今天在GOOGLE上查图片资料,这一幕真让我纠结啊:使用【向前】【向后】这种说法,就默认了有一个对比坐标,那就是当前显示的4张缩略图。点击【