Django REST框架——教程3:基于類的視圖

教程3:基于類的視圖

我們也可以使用基于類的視圖來編寫我們的API視圖,而不是基于功能的視圖痒芝。正如我們將看到的俐筋,這是一個(gè)強(qiáng)大的模式,使我們可以重用常用功能严衬,并幫助我們保持代碼干爽澄者。

使用基于類的視圖重寫我們的API

我們首先將根視圖重寫為一個(gè)基于類的視圖。這一切都涉及到一些重構(gòu)views.py请琳。

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from django.http import Http404
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status

class SnippetList(APIView):
    """
    List all snippets, or create a new snippet.
    """
    def get(self, request, format=None):
        snippets = Snippet.objects.all()
        serializer = SnippetSerializer(snippets, many=True)
        return Response(serializer.data)

    def post(self, request, format=None):
        serializer = SnippetSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_201_CREATED)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

到現(xiàn)在為止還挺好粱挡。它和前面的例子看起來很相似,但是我們?cè)诓煌腍TTP方法之間有更好的分離俄精。我們還需要更新中的實(shí)例視圖views.py询筏。

class SnippetDetail(APIView):
    """
    Retrieve, update or delete a snippet instance.
    """
    def get_object(self, pk):
        try:
            return Snippet.objects.get(pk=pk)
        except Snippet.DoesNotExist:
            raise Http404

    def get(self, request, pk, format=None):
        snippet = self.get_object(pk)
        serializer = SnippetSerializer(snippet)
        return Response(serializer.data)

    def put(self, request, pk, format=None):
        snippet = self.get_object(pk)
        serializer = SnippetSerializer(snippet, data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

    def delete(self, request, pk, format=None):
        snippet = self.get_object(pk)
        snippet.delete()
        return Response(status=status.HTTP_204_NO_CONTENT)

這看起來不錯(cuò)。同樣竖慧,它現(xiàn)在仍然與基于功能的視圖非常相似嫌套。

我們snippets/urls.py現(xiàn)在還需要稍微重構(gòu)我們使用基于類的視圖。

from django.conf.urls import url
from rest_framework.urlpatterns import format_suffix_patterns
from snippets import views

urlpatterns = [
    url(r'^snippets/$', views.SnippetList.as_view()),
    url(r'^snippets/(?P<pk>[0-9]+)/$', views.SnippetDetail.as_view()),
]

urlpatterns = format_suffix_patterns(urlpatterns)

好的圾旨,我們完成了踱讨。如果你運(yùn)行開發(fā)服務(wù)器,一切都應(yīng)該像以前一樣工作砍的。

使用mixin

使用基于類的視圖的一個(gè)重大勝利是它允許我們輕松地構(gòu)造可重復(fù)使用的行為痹筛。

到目前為止,我們使用的創(chuàng)建/檢索/更新/刪除操作對(duì)于我們創(chuàng)建的任何模型支持的API視圖將非常相似。這些常見的行為是在REST框架的mixin類中實(shí)現(xiàn)的谣旁。

我們來看看如何使用mixin類來構(gòu)建視圖。這是我們的views.py模塊了蔓挖。

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from rest_framework import mixins
from rest_framework import generics

class SnippetList(mixins.ListModelMixin,
                  mixins.CreateModelMixin,
                  generics.GenericAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer

    def get(self, request, *args, **kwargs):
        return self.list(request, *args, **kwargs)

    def post(self, request, *args, **kwargs):
        return self.create(request, *args, **kwargs)

我們將花一點(diǎn)時(shí)間仔細(xì)檢查這里發(fā)生的事情。我們正在建立我們的觀點(diǎn)瘟判,使用GenericAPIView和添加ListModelMixinCreateModelMixin

基類提供核心功能角溃,mixin類提供.list().create()操作。然后减细,我們明確地將方法getpost方法綁定到適當(dāng)?shù)牟僮鳌5侥壳盀橹棺銐蚝?jiǎn)單未蝌。

class SnippetDetail(mixins.RetrieveModelMixin,
                    mixins.UpdateModelMixin,
                    mixins.DestroyModelMixin,
                    generics.GenericAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer

    def get(self, request, *args, **kwargs):
        return self.retrieve(request, *args, **kwargs)

    def put(self, request, *args, **kwargs):
        return self.update(request, *args, **kwargs)

    def delete(self, request, *args, **kwargs):
        return self.destroy(request, *args, **kwargs)

很相似驮吱。同樣,我們正在使用的GenericAPIView類來提供核心功能萧吠,并混入增加提供.retrieve()左冬,.update().destroy()行動(dòng)。

使用通用的基于類的視圖

使用mixin類纸型,我們重寫了視圖拇砰,使用比以前稍少的代碼,但是我們可以更進(jìn)一步狰腌。REST框架提供了一組已經(jīng)混合的通用視圖除破,我們可以使用它們更多地修剪我們的views.py模塊。

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from rest_framework import generics

class SnippetList(generics.ListCreateAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer

class SnippetDetail(generics.RetrieveUpdateDestroyAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer

哇琼腔,這很簡(jiǎn)潔瑰枫。我們已經(jīng)獲得了大量的免費(fèi),而且我們的代碼看起來很好展姐,干凈躁垛,慣用的Django。

接下來圾笨,我們將進(jìn)入本教程的第4部分教馆,在這里我們將看看如何處理我們的API的身份驗(yàn)證和權(quán)限。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末擂达,一起剝皮案震驚了整個(gè)濱河市土铺,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖悲敷,帶你破解...
    沈念sama閱讀 216,372評(píng)論 6 498
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件究恤,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡后德,警方通過查閱死者的電腦和手機(jī)部宿,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,368評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來瓢湃,“玉大人理张,你說我怎么就攤上這事∶嗷迹” “怎么了雾叭?”我有些...
    開封第一講書人閱讀 162,415評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)落蝙。 經(jīng)常有香客問我织狐,道長(zhǎng),這世上最難降的妖魔是什么筏勒? 我笑而不...
    開封第一講書人閱讀 58,157評(píng)論 1 292
  • 正文 為了忘掉前任移迫,我火速辦了婚禮,結(jié)果婚禮上管行,老公的妹妹穿的比我還像新娘起意。我一直安慰自己,他們只是感情好病瞳,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,171評(píng)論 6 388
  • 文/花漫 我一把揭開白布套菜。 她就那樣靜靜地躺著逗柴,像睡著了一般顿肺。 火紅的嫁衣襯著肌膚如雪映砖。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,125評(píng)論 1 297
  • 那天仔燕,我揣著相機(jī)與錄音蒙袍,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛闰围,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播羡榴,決...
    沈念sama閱讀 40,028評(píng)論 3 417
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼校仑!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起肤视,我...
    開封第一講書人閱讀 38,887評(píng)論 0 274
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎腐螟,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體困后,經(jīng)...
    沈念sama閱讀 45,310評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,533評(píng)論 2 332
  • 正文 我和宋清朗相戀三年汽绢,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片宁昭。...
    茶點(diǎn)故事閱讀 39,690評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖积仗,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情蜕猫,我是刑警寧澤,帶...
    沈念sama閱讀 35,411評(píng)論 5 343
  • 正文 年R本政府宣布隆圆,位于F島的核電站,受9級(jí)特大地震影響翔烁,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜租漂,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,004評(píng)論 3 325
  • 文/蒙蒙 一颊糜、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧衬鱼,春花似錦、人聲如沸憔杨。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,659評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至寻狂,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間蛇券,已是汗流浹背缀壤。 一陣腳步聲響...
    開封第一講書人閱讀 32,812評(píng)論 1 268
  • 我被黑心中介騙來泰國(guó)打工纠亚, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人蒂胞。 一個(gè)月前我還...
    沈念sama閱讀 47,693評(píng)論 2 368
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像骗随,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子鸿染,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,577評(píng)論 2 353

推薦閱讀更多精彩內(nèi)容