溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
官方文檔[這里]
用于分頁的模塊: Pagination
Django REST framework 有內置 Pagination 模塊，無需額外安裝, 只需做簡單的配置.
配置什么呢? 就是告訴Django要用到什么樣的分頁樣式, 比如: 返回哪些字段, 每頁的大小, 請求參數的名稱等等.
2種配置途徑:
1.settings.py 文件里做全局的配置
2.單獨為每個需要分頁的 view 分配自定義分頁器.
途徑1是為所有繼承ListViewAPI的接口做默認配置, 途徑2對單獨一個接口做個性化配置.
需要注意的是: 途徑1做了全局的配置, 所有繼承 ListAPIView 的接口,默認都會有分頁. 這會影響到現有接口返回數據的結構. 除了這一點, 途徑1還是相當不錯的.
我比較喜歡僅使用途徑2, 我可以自定義了一個通用型的分頁器, 只為有需要分頁的view分配分頁器, 也是挺方便的.
途徑1: settings.py文件里做全局配置
REST_FRAMEWORK = {
# ...
'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
'PAGE_SIZE': 100
}
DEFAULT_PAGINATION_CLASS: 默認分頁器(BasePagination的子類). Django提供了3個類型: PageNumberPagination、LimitOffsetPagination、CursorPagination. 不同類型返回的分頁信息不同. 也可以是你自定義的分頁器.
PAGE_SIZE: 分頁大小.
途徑2: 自定義分頁器
這里將示例使用自定義分頁器的流程.
新建一個 paginations.py 用于寫分頁器:
我們在 paginations.py 文件里寫一個通用的分頁器:
class StandarPagination(PageNumberPagination):
page_size = 20 # 默認每頁顯示條數配置
page_query_param = 'page' # “頁數”的請求參數名稱, 默認是page
page_size_query_param = 'page_size' # “分頁大小”的請求參數名稱
# 進入父類 PageNumberPagination 可看響應體返回字段.
# 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)
# ]))
# 覺得不適用, 那就拷貝出來,重載函數, 自己多加幾個字段.
# (可通過官方文檔或直接調試得知從哪些屬性獲取正確的值.)
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.
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持億速云。
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
