前言
在RESTful
规范中,有关版本的问题,用restful
规范做开放接口的时候,用户请求API
,系统返回数据。但是难免在系统发展的过程中,不可避免的需要添加新的资源,或者修改现有资源。因此,改动升级必不可少,但是,作为平台开发者,应该知道:一旦API
开放出去,有人开始用了,平台的任何改动都需要考虑对当前用户的影响。因此,做开放平台,从第一个API
的设计就需要开始API
的版本控制策略问题,API
的版本控制策略就像是开放平台和平台用户之间的长期协议,其设计的好坏将直接决定用户是否使用该平台,或者说用户在使用之后是否会因为某次版本升级直接弃用该平台。
1.配置
有两种配置方案,一种是在settings
中全局配置,第二种是在视图中指定,不过此方法一般不使用
,因为版本控制大部分情况下是全局的处理情况
1.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
的值必须是列