Django rest framework使用類視圖實(shí)現(xiàn)首頁(yè)API
django-rest-framework 類視圖拓展自 django 的類視圖,只是針對(duì)數(shù)據(jù)的序列化和反序列化等邏輯做了封裝。
django-rest-framework 中最基本的類視圖是 views.APIView,這個(gè)類可以看成是上一篇教程中用到的 api_view 裝飾器的類版本。這個(gè)類比較基礎(chǔ),其核心功能就是 HTTP 請(qǐng)求預(yù)處理、分發(fā)請(qǐng)求給對(duì)應(yīng)的處理函數(shù),以及 HTTP 響應(yīng)后處理,還有就是 as_view 方法將類轉(zhuǎn)為函數(shù)(要注意與被請(qǐng)求的 URL 綁定的視圖必須是一個(gè)可調(diào)用對(duì)象,普通的的類是無(wú)法被直接調(diào)用的)。除非需要深度定制視圖函數(shù)的邏輯,一般情況下我們的視圖不會(huì)直接繼承這個(gè)類。
更為通用的類視圖是 GenericAPIView,這個(gè)類繼承自 APIView,對(duì)基類的功能做了拓展。繼承自這個(gè)類的視圖,只需對(duì)其類屬性做一些簡(jiǎn)單的配置,就能獲得獲取單個(gè)資源、獲取資源列表、資源列表分頁(yè)等功能。當(dāng)然,這個(gè)類作為其他特定功能類視圖的基類,我們一般也很少使用。
回顧一下此前講的 RESTful 架構(gòu)的基本概念,客戶端使用 URL 訪問(wèn)資源,通過(guò) HTTP 請(qǐng)求的動(dòng)詞表達(dá)對(duì)資源的操作。django-rest-framework 針對(duì)各種類型的資源操作,提供了對(duì)應(yīng)的通用類視圖,這些通用類視圖主要包括:
CreateAPIView
用于創(chuàng)建資源的 POST 請(qǐng)求。
ListAPIView 和 RetrieveAPIView
用于訪問(wèn)資源列表和單個(gè)資源的 GET 請(qǐng)求。
DestroyAPIView
用于刪除資源的 DELETE 請(qǐng)求。
UpdateAPIView
用于更新資源的 PUT(全量更新)和 PATCH(部分更新)請(qǐng)求。
以及以上視圖的各種組合通用類視圖:ListCreateAPIView、RetrieveUpdateAPIView、RetrieveDestroyAPIView、RetrieveUpdateDestroyAPIView。
博客首頁(yè) API 返回首頁(yè)文章列表數(shù)據(jù),顯然應(yīng)該選用的是 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!首頁(yè) API 就寫好了。我們基本沒(méi)有寫任何邏輯代碼,只是指定了類視圖的幾個(gè)屬性值。因?yàn)檫壿嫽径际峭ㄓ玫?,通用類視圖在背后幫我們做了全部工作,我們只要告訴它:用哪個(gè)序列化器去做,序列化哪個(gè)資源等就可以了。以這里的類視圖為例,我們指定了:
使用 PostListSerializer 序列化器(通過(guò) serializer_class 指定);
序列化博客文章(Post)列表(通過(guò) queryset 指定);
對(duì)資源列表分頁(yè)(通過(guò) pagination_class 指定,PageNumberPagination 會(huì)自動(dòng)對(duì)資源進(jìn)行分頁(yè),后面的教程會(huì)詳細(xì)介紹分頁(yè)功能);
允許任何人訪問(wèn)該資源(通過(guò) permission_classes 指定,AllowAny 權(quán)限類不對(duì)任何訪問(wèn)做攔截,即允許任何人調(diào)用這個(gè) API 以訪問(wèn)其資源)。
最后一步就是在 urls.py 中綁定接口,把原來(lái)綁定的函數(shù)視圖改為現(xiàn)在的類視圖:
path('api/index/', views.IndexPostListAPIView.as_view())
啟動(dòng)開發(fā)服務(wù)器,打開瀏覽器訪問(wèn) http://127.0.0.1:8000/api/index/,可以看到和上一篇教程中使用函數(shù)視圖返回的結(jié)果是一樣的:
{
"count": 201,
"next": "http://127.0.0.1:10000/api/index/?page=2",
"previous": null,
"results": [
{
"id": 1,
"title": "Markdown 與代碼高亮測(cè)試",
"created_time": "2020-04-23T14:22:36.129383+08:00",
"excerpt": "歡迎使用馬克飛象\n@(示例筆記本)[馬克飛象|幫助|Markdown]\n馬克飛象是一款專為印象筆記(Ever",
"category": {
"id": 6,
"name": "Markdown測(cè)試"
},
"author": {
"id": 1,
"username": "admin"
},
"views": 0
}
]
}
而且可以看到,返回的結(jié)果進(jìn)行了分頁(yè),next 字段指示了下一頁(yè)的鏈接,這樣分頁(yè)訪問(wèn)資源就變的非常方便了。
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
- Django restful framework生成API文檔過(guò)程詳解
- 詳解Django rest_framework實(shí)現(xiàn)RESTful API
- Python3+RIDE+RobotFramework自動(dòng)化測(cè)試框架搭建過(guò)程詳解
- 基于Jenkins搭建.NET FrameWork持續(xù)集成環(huán)境
- Django rest framework分頁(yè)接口實(shí)現(xiàn)原理解析
- 簡(jiǎn)單了解.NET Framework
- django restframework serializer 增加自定義字段操作
- Restful_framework視圖組件代碼實(shí)例解析
相關(guān)文章
Ribbon負(fù)載均衡服務(wù)調(diào)用的示例詳解
Rbbo其實(shí)就是一個(gè)軟負(fù)載均衡的客戶端組件,他可以和其他所需請(qǐng)求的客戶端結(jié)合使用,這篇文章主要介紹了Ribbon負(fù)載均衡服務(wù)調(diào)用案例代碼,需要的朋友可以參考下2023-01-01
通過(guò)Java創(chuàng)建Socket連接到服務(wù)器方式
這篇文章主要介紹了通過(guò)Java創(chuàng)建Socket連接到服務(wù)器方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-11-11
springboot如何忽略接收請(qǐng)求中的參數(shù)
這篇文章主要介紹了springboot如何忽略接收請(qǐng)求中的參數(shù)問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-07-07
Java?中向?Arraylist?添加對(duì)象的示例代碼
本文介紹了如何在 Java 中向 ArrayList 添加對(duì)象,并提供了示例和注意事項(xiàng),通過(guò)掌握這些知識(shí),讀者可以在自己的 Java 項(xiàng)目中有效地使用 ArrayList 來(lái)存儲(chǔ)和操作對(duì)象,需要的朋友可以參考下2023-11-11
使用kotlin集成springboot開發(fā)的超詳細(xì)教程
目前大多數(shù)都在使用java集成 springboot進(jìn)行開發(fā),本文演示僅僅將 java換成 kotlin,其他不變的情況下進(jìn)行開發(fā),需要的朋友可以參考下2021-09-09

