rest-framework之版本控制

本文目錄

• 一 作用
• 二 內建的版本控制類
• 三 區域性使用
• 四 全域性使用
• 五 示例
• 原始碼分析

回到目錄

一 作用

用於版本的控制

回到目錄

二 內建的版本控制類

from rest_framework.versioning import QueryParameterVersioning,AcceptHeaderVersioning,NamespaceVersioning,URLPathVersioning

 
#基於url的get傳參方式：QueryParameterVersioning------>如：/users?version=v1
#基於url的正則方式：URLPathVersioning------>/v1/users/
#基於 accept 請求頭方式：AcceptHeaderVersioning------>Accept: application/json; version=1.0
#基於主機名方法：HostNameVersioning------>v1.example.com
#基於django路由系統的namespace：NamespaceVersioning------>example.com/v1/users/
 

回到目錄

三 區域性使用

#在CBV類中加入
versioning_class = URLPathVersioning

回到目錄

四 全域性使用

REST_FRAMEWORK = {
    'DEFAULT_VERSIONING_CLASS':'rest_framework.versioning.QueryParameterVersioning',
    'DEFAULT_VERSION': 'v1',            #
 
 預設版本(從request物件裡取不到，顯示的預設值)
    'ALLOWED_VERSIONS': ['v1', 'v2'],   # 允許的版本
    'VERSION_PARAM': 'version'          # URL中獲取值的key
}

回到目錄

五 示例

基於正則的方式：

from django.conf.urls import url, include
from web.views import TestView

urlpatterns = [
    url(r'^(?P<version>[v1|v2]+)/test/', TestView.as_view(), name='test'),
]

url

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.versioning import URLPathVersioning


class TestView(APIView):
    versioning_class = URLPathVersioning

    def get(self, request, *args, **kwargs):
        # 獲取版本
        print(request.version)
        # 獲取版本管理的類
        print(request.versioning_scheme)

        # 反向生成URL
        reverse_url = request.versioning_scheme.reverse('test', request=request)
        print(reverse_url)

        return Response('GET請求，響應內容')

views.py

        # 基於django內建,反向生成url
        from django.urls import reverse
        url2=reverse(viewname='ttt',kwargs={'version':'v2'})
        print(url2)

View Code

 

回到目錄

原始碼分析

#執行determine_version，返回兩個值，放到request物件裡
version, scheme = self.determine_version(request, *args, **kwargs)
request.version, request.versioning_scheme = version, scheme

def determine_version(self, request, *args, **kwargs):
        #當配置上版本類之後，就會例項化
        if self.versioning_class is None:
            return (None, None)
        scheme = self.versioning_class()
        return (scheme.determine_version(request, *args, **kwargs), scheme)

 

• 一 作用
• 二 內建的版本控制類
• 三 區域性使用
• 四 全域性使用
• 五 示例
• 原始碼分析

回到目錄

一 作用

用於版本的控制

回到目錄

二 內建的版本控制類

from rest_framework.versioning import QueryParameterVersioning,AcceptHeaderVersioning,NamespaceVersioning,URLPathVersioning

#基於url的get傳參方式：QueryParameterVersioning------>如：/users?version=v1
#基於url的正則方式：URLPathVersioning------>/v1/users/
#基於 accept 請求頭方式：AcceptHeaderVersioning------>Accept: application/json; version=1.0
#基於主機名方法：HostNameVersioning------>v1.example.com
#基於django路由系統的namespace：NamespaceVersioning------>example.com/v1/users/

回到目錄

三 區域性使用

#在CBV類中加入
versioning_class = URLPathVersioning

回到目錄

四 全域性使用

REST_FRAMEWORK = {
    'DEFAULT_VERSIONING_CLASS':'rest_framework.versioning.QueryParameterVersioning',
    'DEFAULT_VERSION': 'v1',            # 預設版本(從request物件裡取不到，顯示的預設值)
    'ALLOWED_VERSIONS': ['v1', 'v2'],   # 允許的版本
    'VERSION_PARAM': 'version'          # URL中獲取值的key
}

回到目錄

五 示例

基於正則的方式：

from django.conf.urls import url, include
from web.views import TestView

urlpatterns = [
    url(r'^(?P<version>[v1|v2]+)/test/', TestView.as_view(), name='test'),
]

url

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.versioning import URLPathVersioning


class TestView(APIView):
    versioning_class = URLPathVersioning

    def get(self, request, *args, **kwargs):
        # 獲取版本
        print(request.version)
        # 獲取版本管理的類
        print(request.versioning_scheme)

        # 反向生成URL
        reverse_url = request.versioning_scheme.reverse('test', request=request)
        print(reverse_url)

        return Response('GET請求，響應內容')

views.py

        # 基於django內建,反向生成url
        from django.urls import reverse
        url2=reverse(viewname='ttt',kwargs={'version':'v2'})
        print(url2)

View Code

 

回到目錄

原始碼分析

#執行determine_version，返回兩個值，放到request物件裡
version, scheme = self.determine_version(request, *args, **kwargs)
request.version, request.versioning_scheme = version, scheme

def determine_version(self, request, *args, **kwargs):
        #當配置上版本類之後，就會例項化
        if self.versioning_class is None:
            return (None, None)
        scheme = self.versioning_class()
        return (scheme.determine_version(request, *args, **kwargs), scheme)