Django REST framework 分頁的實現(xiàn)代碼
官方文檔[這里]
用于分頁的模塊: Pagination
Django REST framework 有內(nèi)置 Pagination 模塊,無需額外安裝, 只需做簡單的配置.
配置什么呢? 就是告訴Django要用到什么樣的分頁樣式, 比如: 返回哪些字段, 每頁的大小, 請求參數(shù)的名稱等等.
2種配置途徑:
1.settings.py 文件里做全局的配置
2.單獨為每個需要分頁的 view 分配自定義分頁器.
途徑1是為所有繼承ListViewAPI的接口做默認(rèn)配置, 途徑2對單獨一個接口做個性化配置.
需要注意的是: 途徑1做了全局的配置, 所有繼承 ListAPIView 的接口,默認(rèn)都會有分頁. 這會影響到現(xiàn)有接口返回數(shù)據(jù)的結(jié)構(gòu). 除了這一點, 途徑1還是相當(dāng)不錯的.
我比較喜歡僅使用途徑2, 我可以自定義了一個通用型的分頁器, 只為有需要分頁的view分配分頁器, 也是挺方便的.
途徑1: settings.py文件里做全局配置
REST_FRAMEWORK = { # ... 'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination', 'PAGE_SIZE': 100 }
DEFAULT_PAGINATION_CLASS: 默認(rèn)分頁器(BasePagination的子類). Django提供了3個類型: PageNumberPagination、LimitOffsetPagination、CursorPagination. 不同類型返回的分頁信息不同. 也可以是你自定義的分頁器.
PAGE_SIZE: 分頁大小.
途徑2: 自定義分頁器
這里將示例使用自定義分頁器的流程.
新建一個 paginations.py 用于寫分頁器:
我們在 paginations.py 文件里寫一個通用的分頁器:
class StandarPagination(PageNumberPagination): page_size = 20 # 默認(rèn)每頁顯示條數(shù)配置 page_query_param = 'page' # “頁數(shù)”的請求參數(shù)名稱, 默認(rèn)是page page_size_query_param = 'page_size' # “分頁大小”的請求參數(shù)名稱 # 進(jìn)入父類 PageNumberPagination 可看響應(yīng)體返回字段. # def get_paginated_response(self, data): # return Response(OrderedDict([ # ('count', self.page.paginator.count), # ('next', self.get_next_link()), # ('previous', self.get_previous_link()), # ('results', data) # ])) # 覺得不適用, 那就拷貝出來,重載函數(shù), 自己多加幾個字段. # (可通過官方文檔或直接調(diào)試得知從哪些屬性獲取正確的值.) def get_paginated_response(self, data): return Response(OrderedDict([ ('count', self.page.paginator.count), ('next', self.get_next_link()), ('previous', self.get_previous_link()), ('page', self.page.number), ('total_page', self.page.paginator.num_pages), ('page_size', self.page.paginator.per_page), ('results', data) ]))
(更多的屬性介紹請查看文檔)
為接口分配分頁器, 為屬性 pagination_class 賦值即可.
from rest_framework.pagination import PageNumberPagination class MyListAPI(ListAPIView): queryset = TestModel.objects.filter() serializer_class = TestModelSerializer pagination_class = StandarPagination # 新增
完成!
假如該接口請求地址是 http://api/test/
看客戶端是如何請求接口的:
http://api/test/ : 返回第一頁, 分頁大小是20.
http://api/test/?page=2&page_size=10: 返回第二頁,分頁大小是10.
以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
Python3+RIDE+RobotFramework自動化測試框架搭建過程詳解
這篇文章主要介紹了Python3+RIDE+RobotFramework自動化測試框架搭建過程詳解,本文通過圖文并茂的形式給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-09-09scrapy爬蟲:scrapy.FormRequest中formdata參數(shù)詳解
這篇文章主要介紹了scrapy爬蟲:scrapy.FormRequest中formdata參數(shù)詳解,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-04-04Python2和Python3讀取文本文件的區(qū)別及說明
這篇文章主要介紹了Python2和Python3讀取文本文件的區(qū)別及說明,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-02-02Django?Rest?Framework實現(xiàn)身份認(rèn)證源碼詳解
這篇文章主要為大家介紹了Django?Rest?Framework實現(xiàn)身份認(rèn)證源碼詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-05-05Python2.7+pytesser實現(xiàn)簡單驗證碼的識別方法
這篇文章主要介紹了Python2.7+pytesser實現(xiàn)簡單驗證碼的識別方法,簡單分析了pytesser的安裝及Python2.7環(huán)境下實現(xiàn)驗證碼識別的相關(guān)操作技巧,需要的朋友可以參考下2017-12-12Jupyter?notebook運行后打不開網(wǎng)頁的問題解決
本文主要介紹了Jupyter?notebook運行后打不開網(wǎng)頁的問題解決,文中通過示例代碼介紹的非常詳細(xì),具有一定的參考價值,感興趣的小伙伴們可以參考一下2022-03-03