Configure settings, global configuration paging

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS':  'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 10  # Number of pages
}

Custom Pagination class

from collections import OrderedDict

from django.core.paginator import InvalidPage
from rest_framework.exceptions import NotFound
from rest_framework.pagination import PageNumberPagination

#http://127.0.0.1:9008/book/?page=1&page_size=6
from rest_framework.response import Response


class BookListPager(PageNumberPagination):
    page_size = 5  # 5 records per page
    page_size_query_param = 'page_size'  # Parameter name of the number of records per page


    # Custom pagination form
    def get_paginated_response(self, data):
        return Response(OrderedDict([
            ('count', self.page.paginator.count),
            ('page_range', list(self.page.paginator.page_range)),  # Page range
            ('has_next', self.page.has_next()),
            ('has_prious', self.page.has_previous()),
            ('next_page_number', self.page.next_page_number()),
            ('results', data)
        ]))

Note: If you turn off the paging function in the view, just set it in the view

pagination_class = None

Optional pager

1> PageNumberPagination

Front-end access URL form:

GET  http://api.example.org/books/?page=4

Properties that can be defined in subclasses:
page_size per page
page_query_param The page keyword name sent by the front end, the default is "page"
page_size_query_param The keyword name per page sent by the front end, the default is None
max_page_size The maximum number per page that can be set by the front end

from rest_framework.pagination import PageNumberPagination
    class StandardPageNumberPagination(PageNumberPagination):    page_size_query_param = 'page_size'

    max_page_size = 10

    class BookListView(ListAPIView):    queryset = BookInfo.objects.all().order_by('id')

    serializer_class = BookInfoSerializer
    pagination_class = StandardPageNumberPagination
    # 127.0.0.1/books/?page=1&page_size=2

2> LimitOffsetPagination

Front-end access URL form:

GET http://api.example.org/books/?limit=100&offset=400

Properties that can be defined in subclasses:
default_limit The default limit, the default value is the same as the PAGE_SIZE setting
limit_query_paramlimit parameter name, default ‘limit’
offset_query_param offset parameter name, default ’offset’
max_limit The maximum limit, the default is None

from rest_framework.pagination import LimitOffsetPagination
    class BookListView(ListAPIView):    queryset = BookInfo.objects.all().order_by('id')

    serializer_class = BookInfoSerializer
    pagination_class = LimitOffsetPagination
    # 127.0.0.1:8000/books/?offset=3&limit=2