浅析Django接口版本控制


Posted in Python onJune 26, 2021

一、前言

RESTful规范中,有关版本的问题,用restful规范做开放接口的时候,用户请求API,系统返回数据。但是难免在系统发展的过程中,不可避免的需要添加新的资源,或者修改现有资源。因此,改动升级必不可少,但是,作为平台开发者,应该知道:一旦API开放出去,有人开始用了,平台的任何改动都需要考虑对当前用户的影响。因此,做开放平台,从第一个API的设计就需要开始API的版本控制策略问题,API的版本控制策略就像是开放平台和平台用户之间的长期协议,其设计的好坏将直接决定用户是否使用该平台,或者说用户在使用之后是否会因为某次版本升级直接弃用该平台。

二、配置

有两种配置方案,一种是在settings中全局配置,第二种是在视图中指定,不过此方法一般不使用,因为版本控制大部分情况下是全局的处理情况

2.1、全局配置

settings.py

REST_FRAMEWORK = {
    'DEFAULT_VERSIONING_CLASS': None,
    'DEFAULT_VERSION': None,
    'ALLOWED_VERSIONS': None,
    'VERSION_PARAM': 'version',
}
  • DEFAULT_VERSIONING_CLASS:指定版本控制的类,譬如:'rest_framework.versioning.NamespaceVersioning',有多种方式。默认为None,为None时,框架变量request.version将始终返回None
  • DEFAULT_VERSION:当版本控制信息不存在时用于设置request.version的默认值,默认设置为None。
  • ALLOWED_VERSIONS:允许的版本号,譬如:['v1', 'v2']。区分大小写,如果请求的版本号不在此列表中,抛出错误,上述的 DEFAULT_VERSION 的值必须是列表中的值,None除外
  • VERSION_PARAM:版本控制参数的字符串,默认就是version,一般不修改

2.2、视图配置

views.py

# 仅仅指定 版本控制类    
class ProfileList(APIView):
    # 指定 版本控制类
    versioning_class = versioning.QueryParameterVersioning

三、drf内置的5个版本控制类

3.1、AcceptHeaderVersioning

基于请求头的版本控制,这种方式也是最推荐的方式

1.http访问方式

GET /bookings/ HTTP/1.1

Host: example.com

Accept: application/json; version=1.0

在上面的示例请求中request.version属性将返回字符串'1.0'。 基于accept headers 的版本控制通常被认为是最佳实践,尽管其他版本控制方式可能适合你的客户端需求。

2.settings

REST_FRAMEWORK = {
	'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.AcceptHeaderVersioning',
        'DEFAULT_VERSION': 'v1',
        'ALLOWED_VERSIONS': ['v1', 'v2'],
}

说明:

  • 设置版本控制类为AcceptHeaderVersioning
  • 没有检测到version时,默认是v1版本
  • 允许的2个版本型号为:['v1', 'v2']

3.serializers

class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = BookInfo
        fields = ['title', 'pub_date', 'read', 'comment', 'image']


class BookSerializerV2(serializers.ModelSerializer):
    class Meta:
        model = BookInfo
        fields = ['title', 'pub_date', 'read', 'comment']

说明:

  • 根据不同的版本号,可以对response返回内容进行控制,我们设置2个不同的Book模型的serializer类对应不同的版本
  • 2个序列化类返回的字段不同
  • BookSerializerV2fields中没有包含 image ,那么就应该把属性定义去掉,不然会抛出错误

4.views

class BookView(ListAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookSerializer

    def get_serializer_class(self):
        if self.request.version == "v2":
            return BookSerializerV2
        return self.serializer_class

说明:

  • 修改BookView类,重载get_serializer_class方法
  • 通过 self.request.version 获取捕获到的版本号进行控制

5.访问

我们在请求头中添加字段Accept:application/json;version=v1,就会返回BookSerializer的序列化字段,也就是有image字段

浅析Django接口版本控制

我们在请求头中添加字段Accept:application/json;version=v2,就会返回BookSerializerV2的序列化字段,也就是没有image字段

浅析Django接口版本控制

3.2、URLPathVersioning

此方案要求客户端将版本指定为URL路径的一部分。

1.http访问方式

GET /v1/bookings/ HTTP/1.1

Host: example.com

Accept: application/json

说明:

版本控制出现在url路径中,但是具体的这个 v1 出现在哪个部分,取决于url路由配置中的情况

2.settings

REST_FRAMEWORK = {
	'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.URLPathVersioning',
        'DEFAULT_VERSION': 'v1',
        'ALLOWED_VERSIONS': ['v1', 'v2'],
}

3.urls

子应用的urls.py中:

urlpatterns = [
    path('<str:version>/books/', views.BookView.as_view()),
]

说明:

设置版本控制在最后,访问url是类似:http://127.0.0.1:8000/api/v2/books/

4.访问

我们在配置好url后,在url中输入v1,就会访问v1版本的接口

浅析Django接口版本控制

url中输入v2,就会访问v2版本的接口

浅析Django接口版本控制

3.3、NamespaceVersioning

对于客户端,此方案与URLPathVersioning相同。唯一的区别是,它是如何在 Django 应用程序中配置的,因为它使用URL conf中的命名空间而不是URL conf中的关键字参数。

使用此方案,request.version属性是根据与传入请求的路径匹配的 namespace 确定的。

如果你只需要一个简单的版本控制方案URLPathVersioningNamespaceVersioning都是合适的。URLPathVersioning这种方法可能更适合小型项目,对于更大的项目来说NamespaceVersioning可能更容易管理。

1.http访问方式

GET v1/something/ HTTP/1.1

Host: example.com

2.settings

REST_FRAMEWORK = {
	'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.NamespaceVersioning',
        'DEFAULT_VERSION': 'v1',
        'ALLOWED_VERSIONS': ['v1', 'v2'],
}

3.urls

根urls.py中:

urlpatterns = [
    path('v1/api/', include('api.urls', namespace='v1')),
    path('v2/api/', include('api.urls', namespace='v2')),
]

说明:

增加了2个v1v2的不同的路由配置

4.访问

访问v1版本

浅析Django接口版本控制

访问v2版本

浅析Django接口版本控制

其余HostNameVersioningQueryParameterVersioning用的不多,想了解的可以查询官方文档

以上就是浅析Django接口版本控制的详细内容,更多关于Django接口版本控制的资料请关注三水点靠木其它相关文章!

Python 相关文章推荐
简单谈谈python中的Queue与多进程
Aug 25 Python
Python实现获取本地及远程图片大小的方法示例
Jul 21 Python
win7 x64系统中安装Scrapy的方法
Nov 18 Python
python 协程 gevent原理与用法分析
Nov 22 Python
Python爬虫爬取电影票房数据及图表展示操作示例
Mar 27 Python
Python @property及getter setter原理详解
Mar 31 Python
JupyterNotebook 输出窗口的显示效果调整方法
Apr 13 Python
PyQt5实现登录页面
May 30 Python
python高级特性简介
Aug 13 Python
Python 高效编程技巧分享
Sep 10 Python
总结Pyinstaller打包的高级用法
Jun 28 Python
Python Numpy库的超详细教程
Apr 06 Python
浅析Python实现DFA算法
解析目标检测之IoU
pycharm代码删除恢复的方法
Python max函数中key的用法及原理解析
Python访问Redis的详细操作
一文搞懂python异常处理、模块与包
Python实战之OpenCV实现猫脸检测
You might like
菜鸟修复电子管记
2021/03/02 无线电
PHP中替换换行符的几种方法小结
2012/10/15 PHP
Apache下禁止php文件被直接访问的解决方案
2013/04/25 PHP
Fleaphp常见函数功能与用法示例
2016/11/15 PHP
详解PHP序列化和反序列化原理
2018/01/15 PHP
PHP+MySQL实现输入页码跳转到指定页面功能示例
2018/06/01 PHP
php使用scandir()函数扫描指定目录下所有文件示例
2019/06/08 PHP
yii 框架实现按天,月,年,自定义时间段统计数据的方法分析
2020/04/04 PHP
ajax 缓存 问题 requestheader
2010/08/01 Javascript
基于jQuery的试卷自动排版系统实现代码
2011/01/06 Javascript
javascript 基础篇4 window对象,DOM
2012/03/14 Javascript
JavaScript定时器详解及实例
2013/08/01 Javascript
JS脚本defer的作用示例介绍
2014/01/02 Javascript
NodeJS学习笔记之Connect中间件模块(一)
2015/01/27 NodeJs
js实现的牛顿摆效果
2015/03/31 Javascript
深入解读JavaScript中的Hoisting机制
2015/08/12 Javascript
BootStrap的Datepicker控件使用心得分享
2016/05/25 Javascript
Bootstrap基本布局实现方法详解
2016/11/25 Javascript
js实现百度登录框鼠标拖拽效果
2017/03/07 Javascript
vue+node+webpack环境搭建教程
2017/11/05 Javascript
Node层模拟实现multipart表单的文件上传示例
2018/01/02 Javascript
在Vue组件中使用 TypeScript的方法
2018/02/28 Javascript
node.js中TCP Socket多进程间的消息推送示例详解
2018/07/10 Javascript
解决axios发送post请求返回400状态码的问题
2018/08/11 Javascript
一步快速解决微信小程序中textarea层级太高遮挡其他组件
2019/03/04 Javascript
微信小程序用户授权,以及判断登录是否过期的方法
2019/05/10 Javascript
webpack4手动搭建Vue开发环境实现todoList项目的方法
2019/05/16 Javascript
jQuery实现倒计时功能完整示例
2020/06/01 jQuery
python 从远程服务器下载东西的代码
2013/02/10 Python
python dict 字典 以及 赋值 引用的一些实例(详解)
2017/01/20 Python
奥地利智能家居和智能生活网上商店:tink.at
2019/10/07 全球购物
电大毕业生自我鉴定
2014/04/10 职场文书
计算机毕业大学生求职信
2014/06/26 职场文书
中国式结婚:司仪主持词(范文)
2019/07/25 职场文书
使用Python脚本对GiteePages进行一键部署的使用说明
2021/05/27 Python
python之json文件转xml文件案例讲解
2021/08/07 Python