django api framework getting total pages available

Question

Is it possible to get how many pages an API request has available? For example, this is my response:

{
    "count": 44,
    "next": "http://localhost:8000/api/ingested_files/?page=2",
    "previous": null,
    "results": [
        {
            "id": 44,
....

I'm pulling 20 elements per page, so there should be 2 pages in total, but currently the way it's set up I can get next and previous, but there's no context as to what the total amount of pages is. Sure I could do some math and get how many possible pages using the count, but I imagine something like this would be native to the framework, no?

This is my view:

 class IngestedFileView(generics.ListAPIView):
    queryset = IngestedFile.objects.all()
    serializer_class = IngestedFileSerializer

This is my serializer:

class IngestedFileSerializer(serializers.ModelSerializer):
    class Meta:
        model = IngestedFile
        fields = ('id', 'filename', 'ingested_date', 'progress', 'processed', 'processed_date', 'error')

Answer 1

You can create your own pagination serializer:

from django.conf import settings
from rest_framework import pagination
from rest_framework.response import Response


class YourPagination(pagination.PageNumberPagination):

    def get_paginated_response(self, data):
        return Response({
            'links': {
               'next': self.get_next_link(),
               'previous': self.get_previous_link()
            },
            'count': self.page.paginator.count,
            'total_pages': self.page.paginator.num_pages,
            'results': data
        })

In your configuration in settings.py you add YourPagination class as the Default Pagination Class.

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'my_project.apps.pagination.YourPagination',
    'PAGE_SIZE': 20
}

References:

• Custom Pagination