第 4 篇:用類視圖實現首頁 API


作者:HelloGitHub-追夢人物

文中所涉及的示例代碼,已同步更新到 HelloGitHub-Team 倉庫

django-rest-framework 類視圖拓展自 django 的類視圖,只是針對數據的序列化和反序列化等邏輯做了封裝。

django-rest-framework 中最基本的類視圖是 views.APIView,這個類可以看成是上一篇教程中用到的 api_view 裝飾器的類版本。這個類比較基礎,其核心功能就是 HTTP 請求預處理、分發請求給對應的處理函數,以及 HTTP 響應后處理,還有就是 as_view 方法將類轉為函數(要注意與被請求的 URL 綁定的視圖必須是一個可調用對象,普通的的類是無法被直接調用的)。除非需要深度定制視圖函數的邏輯,一般情況下我們的視圖不會直接繼承這個類。

更為通用的類視圖是 GenericAPIView,這個類繼承自 APIView,對基類的功能做了拓展。繼承自這個類的視圖,只需對其類屬性做一些簡單的配置,就能獲得獲取單個資源、獲取資源列表、資源列表分頁等功能。當然,這個類作為其他特定功能類視圖的基類,我們一般也很少使用。

回顧一下此前講的 RESTful 架構的基本概念,客戶端使用 URL 訪問資源,通過 HTTP 請求的動詞表達對資源的操作。django-rest-framework 針對各種類型的資源操作,提供了對應的通用類視圖,這些通用類視圖主要包括:

  • CreateAPIView

    用於創建資源的 POST 請求。

  • ListAPIViewRetrieveAPIView

    用於訪問資源列表和單個資源的 GET 請求。

  • DestroyAPIView

    用於刪除資源的 DELETE 請求。

  • UpdateAPIView

    用於更新資源的 PUT(全量更新)和 PATCH(部分更新)請求。

以及以上視圖的各種組合通用類視圖:ListCreateAPIViewRetrieveUpdateAPIViewRetrieveDestroyAPIViewRetrieveUpdateDestroyAPIView

博客首頁 API 返回首頁文章列表數據,顯然應該選用的是 ListAPIView。其代碼如下:

from rest_framework.generics import ListAPIView
from rest_framework.pagination import PageNumberPagination
from rest_framework.permissions import AllowAny

class IndexPostListAPIView(ListAPIView):
    serializer_class = PostListSerializer
    queryset = Post.objects.all()
    pagination_class = PageNumberPagination
    permission_classes = [AllowAny]

That all!首頁 API 就寫好了。我們基本沒有寫任何邏輯代碼,只是指定了類視圖的幾個屬性值。因為邏輯基本都是通用的,通用類視圖在背后幫我們做了全部工作,我們只要告訴它:用哪個序列化器去做,序列化哪個資源等就可以了。以這里的類視圖為例,我們指定了:

使用 PostListSerializer 序列化器(通過 serializer_class 指定);

序列化博客文章(Post)列表(通過 queryset 指定);

對資源列表分頁(通過 pagination_class 指定,PageNumberPagination 會自動對資源進行分頁,后面的教程會詳細介紹分頁功能);

允許任何人訪問該資源(通過 permission_classes 指定,AllowAny 權限類不對任何訪問做攔截,即允許任何人調用這個 API 以訪問其資源)。

最后一步就是在 urls.py 中綁定接口,把原來綁定的函數視圖改為現在的類視圖:

path('api/index/', views.IndexPostListAPIView.as_view())

啟動開發服務器,打開瀏覽器訪問 http://127.0.0.1:8000/api/index/,可以看到和上一篇教程中使用函數視圖返回的結果是一樣的:

{
    "count": 201,
    "next": "http://127.0.0.1:10000/api/index/?page=2",
    "previous": null,
    "results": [
        {
            "id": 1,
            "title": "Markdown 與代碼高亮測試",
            "created_time": "2020-04-23T14:22:36.129383+08:00",
            "excerpt": "歡迎使用馬克飛象\n@(示例筆記本)[馬克飛象|幫助|Markdown]\n馬克飛象是一款專為印象筆記(Ever",
            "category": {
                "id": 6,
                "name": "Markdown測試"
            },
            "author": {
                "id": 1,
                "username": "admin"
            },
            "views": 0
        }
    ]
}

而且可以看到,返回的結果進行了分頁,next 字段指示了下一頁的鏈接,這樣分頁訪問資源就變的非常方便了。


關注公眾號加入交流群


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM