Django DRF版本号的处理

在restful规范中,后端的API中需要体现版本。如果项目比较大,需要些很多的视图类,在每一个类中都写一遍会比较麻烦,所以drf中也支持了全局配置。在每个版本处理的类中还定义了`reverse`方法,他是用来反向生成URL并携带相关的的版本信息用的。

python 复制代码
REST_FRAMEWORK = {
    "DEFAULT_VERSIONING_CLASS": "rest_framework.versioning.QueryParameterVersioning",  # 处理版本的类的路径
    "VERSION_PARAM": "version",  # URL参数传参时的key,例如:xxxx?version=v1
    "ALLOWED_VERSIONS": ["v1", "v2", "v3"],  # 限制支持的版本,None表示无限制
    "DEFAULT_VERSION": "v1",  # 默认版本
}

一、基于GET传递参数

1、settings.py

python 复制代码
REST_FRAMEWORK={
    "UNAUTHENTICATED_USER": None,

    "VERSION_PARAM":"version",  # 决定url中版本的参数值;不设置默认也是这个值,可以通过修改这里修改,例如改为"v";
    "DEFAULT_VERSION":"v1", # 默认版本
    "ALLOWED_VERSIONS":["v1","v2"] #支持的版本范围
}

2、urls.py

python 复制代码
urlpatterns = [
    # path('admin/', admin.site.urls),
    path('home/', views.HomeView.as_view(),name="hh"),
]

3、views.py

python 复制代码
from rest_framework.versioning import   QueryParameterVersioning

class HomeView(APIView):
    # 传递过程中可以携带版本信息
    # http://127.0.0.1:8000/home/?version=v1 ,会自动读出版本赋值给request.version
    versioning_class = QueryParameterVersioning

    def get(self,request):
        print(request.version)
        print(request.versioning_scheme)

        url = request.versioning_scheme.reverse("hh",request=request)
        print("反向生产URL:",url)

        return Response("...")

二、基于路由传递参数

1、urls.py

python 复制代码
urlpatterns = [
    # 下面这两种写法都可以,一种是基于re_path的路由
    # path('api/<str:version>/home/', views.HomeView.as_view(), name="hh"),
    re_path(r'^api/(?P<version>\w+)/home/',views.HomeView.as_view(),name="hh"),

]

2、settings.py

python 复制代码
REST_FRAMEWORK={
    "UNAUTHENTICATED_USER": None,

    "VERSION_PARAM":"version",  # 决定url中版本的参数值;不设置默认也是这个值,可以通过修改这里,修改;
    "DEFAULT_VERSION":"v1", # 默认版本
    "ALLOWED_VERSIONS":["v1","v2"] #支持的版本范围
}

3、views.py

python 复制代码
from rest_framework.versioning import   URLPathVersioning

class HomeView(APIView):
    # 传递过程中可以携带版本信息
    # http://127.0.0.1:8000/home/?version=v1 ,会自动读出版本赋值给request.version
    versioning_class = URLPathVersioning

    def get(self,request,*args,**kwargs):
        print(request.version)
        print(request.versioning_scheme)

        url = request.versioning_scheme.reverse("hh",request=request)
        print("反向生产URL:",url)

        return Response("...")

三、基于请求头传递参数

1、urls.py

python 复制代码
urlpatterns = [
    # 基于请求头传递参数
    path('api/home/', views.HomeView.as_view(), name="hh"),
]

2、views.py

python 复制代码
from rest_framework.versioning import   QueryParameterVersioning,URLPathVersioning,AcceptHeaderVersioning

class HomeView(APIView):
    versioning_class = AcceptHeaderVersioning

    def get(self,request,*args,**kwargs):
        print(request.version)
        print(request.versioning_scheme)

        url = request.versioning_scheme.reverse("hh",request=request)
        print("反向生产URL:",url)

        return Response("...")

四、在实际项目中,第二种通过URL传递版本号的方式还是比较常用,在使用的时候,可以通过全局配置,在views中就不需要在引入和单独设置了,可以直接使用,案例如下:

1、settings.py

python 复制代码
REST_FRAMEWORK={
    # 版本号传递全局设置
    "VERSION_PARAM":"version",  # 决定url中版本的参数值;不设置默认也是这个值,可以通过修改这里,修改;
    "DEFAULT_VERSION":"v1", # 默认版本
    "ALLOWED_VERSIONS":["v1","v2"], #支 持的版本范围
    "DEFAULT_VERSIONING_CLASS":"rest_framework.versioning.URLPathVersioning",
}

2、urls.py

python 复制代码
  # 基于URL传递参数
    path('api/<str:version>/home/', views.HomeView.as_view(), name="hh"),

3、views.py

python 复制代码
from rest_framework.views import APIView
from rest_framework.response import Response

class HomeView(APIView):
    def get(self,request,*args,**kwargs):
        print(request.version)
        print(request.versioning_scheme)
        url = request.versioning_scheme.reverse("hh",request=request)
        print("反向生产URL:",url)
        return Response("...")
相关推荐
chao_7891 小时前
二分查找篇——搜索旋转排序数组【LeetCode】一次二分查找
数据结构·python·算法·leetcode·二分查找
烛阴1 小时前
Python装饰器解除:如何让被装饰的函数重获自由?
前端·python
workflower2 小时前
MDSE和敏捷开发相互矛盾之处:方法论本质的冲突
数据库·软件工程·敏捷流程·极限编程
Tony小周2 小时前
实现一个点击输入框可以弹出的数字软键盘控件 qt 5.12
开发语言·数据库·qt
noravinsc2 小时前
django 一个表中包括id和parentid,如何通过parentid找到全部父爷id
python·django·sqlite
lifallen2 小时前
Paimon 原子提交实现
java·大数据·数据结构·数据库·后端·算法
ajassi20002 小时前
开源 python 应用 开发(三)python语法介绍
linux·python·开源·自动化
沉默媛2 小时前
如何安装python以及jupyter notebook
开发语言·python·jupyter
TDengine (老段)3 小时前
TDengine 数据库建模最佳实践
大数据·数据库·物联网·时序数据库·tdengine·涛思数据
Elastic 中国社区官方博客3 小时前
Elasticsearch 字符串包含子字符串:高级查询技巧
大数据·数据库·elasticsearch·搜索引擎·全文检索·lucene