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'),
]

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請求，響應內容')

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

原始碼分析

#執行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)

rest-framework之響應器(渲染器)

一 作用

根據 使用者請求URL 或 使用者可接受的型別，篩選出合適的 渲染元件。
使用者請求URL：
http://127.0.0.1:8000/test/?format=json
http://127.0.0.1:8000/test.json

二 內建渲染器

顯示json格式：JSONRenderer

訪問URL：

• http://127.0.0.1:8000/test/?format=json
• http://127.0.0.1:8000/test.json
• http://127.0.0.1:8000/test/

預設顯示格式：BrowsableAPIRenderer（可以修改它的html檔案）

訪問URL：

• http://127.0.0.1:8000/test/?format=api
• http://127.0.0.1:8000/test.api
• http://127.0.0.1:8000/test/

表格方式：AdminRenderer

訪問URL：

• http://127.0.0.1:8000/test/?format=admin
• http://127.0.0.1:8000/test.admin
• http://127.0.0.1:8000/test/

form表單方式：HTMLFormRenderer

訪問URL：

• http://127.0.0.1:8000/test/?format=form
• http://127.0.0.1:8000/test.form
• http://127.0.0.1:8000/test/

三 區域性使用

from rest_framework.renderers import  HTMLFormRenderer,BrowsableAPIRenderer
class BookDetailView(APIView):
    renderer_classes = [HTMLFormRenderer,BrowsableAPIRenderer ]
    def get(self,request,pk):
        book_obj=models.Book.objects.filter(pk=pk).first()
        bs=BookSerializers(book_obj,many=False)
        return Response(bs.data)
    def put(self,request,pk):
        book_obj = models.Book.objects.filter(pk=pk).first()

        bs=BookSerializers(data=request.data,instance=book_obj)
        if bs.is_valid():
            bs.save() # update
            return Response(bs.data)
        else:
            return Response(bs.errors)
    def delete(self,request,pk):
        models.Book.objects.filter(pk=pk).delete()

        return Response("")

四 全域性使用

settings裡配置：

REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES':['rest_framework.renderers.JSONRenderer']
}

五 自定義顯示模版

from rest_framework.renderers import  TemplateHTMLRenderer
class BookDetailView(APIView):
    renderer_classes = [TemplateHTMLRenderer]
    def get(self,request,pk):
        book_obj=models.Book.objects.filter(pk=pk).first()
        bs=BookSerializers(book_obj,many=False)
        return Response(bs.data,template_name='aa.html')

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
{{ title }}
{{ publishDate }}
</body>
</html>

注意：如果同時多個存在時，自動根據URL字尾來選擇渲染器。

TemplateHTMLRenderer