浅析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批量下载图片的三种方法
Apr 22 Python
python实现去除下载电影和电视剧文件名中的多余字符的方法
Sep 23 Python
python实现根据主机名字获得所有ip地址的方法
Jun 28 Python
Python的Django框架中if标签的相关使用
Jul 15 Python
python线程、进程和协程详解
Jul 19 Python
python 数据清洗之数据合并、转换、过滤、排序
Feb 12 Python
python生成器,可迭代对象,迭代器区别和联系
Feb 04 Python
Numpy的简单用法小结
Aug 28 Python
Python实现元素等待代码实例
Nov 11 Python
Python:合并两个numpy矩阵的实现
Dec 02 Python
python Matplotlib数据可视化(1):简单入门
Sep 30 Python
Flask中jinja2的继承实现方法及实例
Mar 03 Python
浅析Python实现DFA算法
解析目标检测之IoU
pycharm代码删除恢复的方法
Python max函数中key的用法及原理解析
Python访问Redis的详细操作
一文搞懂python异常处理、模块与包
Python实战之OpenCV实现猫脸检测
You might like
解析thinkphp的左右值无限分类
2013/06/20 PHP
php 三元运算符实例详细介绍
2016/12/15 PHP
使用PHP+MySql+Ajax+jQuery实现省市区三级联动功能示例
2017/09/15 PHP
PHP实现对数字分隔加千分号的方法
2019/03/18 PHP
javascript 命名规则 变量命名规则
2010/02/25 Javascript
利用JS判断用户是否上网(连接网络)
2013/12/23 Javascript
JavaScript中Math对象方法使用概述
2014/01/02 Javascript
Eclipse去除js(JavaScript)验证错误
2014/02/11 Javascript
用jquery仿做发微博功能示例
2014/04/18 Javascript
setInterval计时器不准的问题解决方法
2014/05/08 Javascript
封装好的一个万能检测表单的方法
2015/01/21 Javascript
js与jquery实时监听输入框值的oninput与onpropertychange方法
2015/02/05 Javascript
使用Object.defineProperty实现简单的js双向绑定
2016/04/15 Javascript
Vue登录注册并保持登录状态的方法
2018/08/17 Javascript
详解mpvue scroll-view自动回弹bug解决方案
2018/10/01 Javascript
vue+SSM实现验证码功能
2018/12/07 Javascript
vue 集成 vis-network 实现网络拓扑图的方法
2019/08/07 Javascript
python3.0 字典key排序
2008/12/24 Python
web.py获取上传文件名的正确方法
2014/08/26 Python
使用Python生成url短链接的方法
2015/05/04 Python
Python 实现简单的shell sed替换功能(实例讲解)
2017/09/29 Python
Python使用matplotlib绘制正弦和余弦曲线的方法示例
2018/01/06 Python
python保存网页图片到本地的方法
2018/07/24 Python
python正则爬取某段子网站前20页段子(request库)过程解析
2019/08/10 Python
Django框架下静态模板的继承操作示例
2019/11/08 Python
python用Tkinter做自己的中文代码编辑器
2020/09/07 Python
Sisley法国希思黎美国官方网站:享誉全球的奢华植物美容品牌
2020/06/27 全球购物
SQL Server笔试题
2012/01/10 面试题
《再见了,亲人》教学反思
2014/02/26 职场文书
食品安全工作实施方案
2014/03/26 职场文书
共产党员岗位承诺书
2014/05/29 职场文书
幽默自我介绍演讲稿
2014/08/21 职场文书
党员查摆四风问题思想汇报
2014/10/25 职场文书
学生检讨书如何写
2014/10/30 职场文书
2014年教务工作总结
2014/12/03 职场文书
用JS写一个发布订阅模式
2021/11/07 Javascript