Paginate relationship in Django REST Framework?

Question

We are using Django REST Framework for our API and we have a need to paginate relationship fields that return multiple items.

To demonstrate using examples similar to those in the documentation:

class TrackSerializer(serializers.ModelSerializer):
    class Meta:
        model = Track
        fields = ('order', 'title')

class AlbumSerializer(serializers.ModelSerializer):
    tracks = TrackSerializer(many=True)

    class Meta:
        model = Album
        fields = ('album_name', 'artist', 'tracks')

Example serialized output for an Album:

{
    'album_name': 'The Grey Album',
    'artist': 'Danger Mouse'
    'tracks': [
        {'order': 1, 'title': 'Public Service Annoucement'},
        {'order': 2, 'title': 'What More Can I Say'},
        {'order': 3, 'title': 'Encore'},
        ...
    ],
}

This becomes problematic where there are say hundreds of tracks in the Album. Is there a way to paginate the 'tracks' in this case?

Ideally, I know that in cases like this, the 'tracks' should maybe point to an API URL that just returns the Tracks for a particular Album - which in turn can be paginated easily. The down side to that approach being the extra request (and hence delay, etc) required to get even the first few tracks. In our case, its important that we be able to get at least a few of the Tracks with the single request to the Album API and then dynamically load the rest of the tracks as and when required.

Does the DRF offer any specific feature or pattern for this? Or are there any work arounds?

Note for future reference. This was followed up on in [this thread](https://groups.google.com/d/msg/django-rest-framework/UtVRH8mHwmU/C6C5OhkEQ80J) on the Django REST framework mailing list. — Tom Christie, Mar 27 '13 at 15:37
You can refer to my answer to the same problem here [enter link description here](https://stackoverflow.com/a/49677960/7469841) — Abdelrahmen Ayman, Apr 05 '18 at 17:20

Chemical Programmer · Answer 1 · 2015-12-24T02:18:40.930

Since DRF 3.1, PaginationSerializer is not supported. Here's solution.

settings.py

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 5
}

serializers.py

from myapp.models import Album, Track
from rest_framework import pagination, serializers

class AlbumSerializer(serializers.HyperlinkedModelSerializer):
    tracks = serializers.SerializerMethodField('paginated_tracks')

    class Meta:
        model = Album

    def paginated_tracks(self, obj):
        tracks = Track.objects.filter(album=obj)
        paginator = pagination.PageNumberPagination()
        page = paginator.paginate_queryset(tracks, self.context['request'])
        serializer = TrackSerializer(page, many=True, context={'request': self.context['request']})
        return serializer.data

class TrackSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Track

OR you can substitute def paginated_tracks for

from rest_framework.settings import api_settings

    def get_paginated_tracks(self, obj):
        tracks = Track.objects.filter(album=obj)[:api_settings.PAGE_SIZE]
        serializer = TrackSerializer(tracks, many=True, context={'request': self.context['request']})
        return serializer.data

It even requires one less queries than above.

this works fine for a single Album, but if you are retrieving album list (which also needs pagination), the pagination parameters set in the request object probably shouldn't be used for track pagination. — eugene, Apr 21 '16 at 02:17
@eugene `paginator.page_query_param = 'track_page'` and `paginator.page_size_query_param = 'track_page_size'` would solve that. also if you `return paginator.get_paginated_response(serializer.data).data` the output is consistent with pagination at the top-level. — gonkan, Mar 19 '18 at 16:50
When i try the first solution , i find that the `page`, return value of `paginate_queryset`, is still a plain list of objects. According to [custom-pagination-styles](https://www.django-rest-framework.org/api-guide/pagination/#custom-pagination-styles), I think the right way to get paginated data is to invoke `get_paginated_response ` after invoking `paginate_queryset`. — H.C.Liu, Feb 06 '19 at 04:24

score 10 · Answer 2 · answered May 08 '14 at 12:21

10

Answer copied from Tom's link above in case of future bit rot:

class TrackSerializer(serializers.ModelSerializer):
    class Meta:
        model = Track
        fields = ('order', 'title')

class PaginatedTrackSerializer(pagination.PaginationSerializer):
    class Meta:
        object_serializer_class = TrackSerializer

class AlbumSerializer(serializers.ModelSerializer):

    tracks = serializers.SerializerMethodField('paginated_tracks')


    class Meta:
        model = Album
        fields = ('album_name', 'artist', 'tracks')


    def paginated_tracks(self, obj):
        paginator = Paginator(obj.tracks.all(), 10)
        tracks = paginator.page(1)

        serializer = PaginatedTrackSerializer(tracks)
        return serializer.data

answered May 08 '14 at 12:21

Malcolm Box

3,968
1
26
44

But how to get page size parameter and page parameter inside the paginated_tracks? – scott May 14 '14 at 14:01
2

Ok, I got it. `request = self.context['request']` – scott May 14 '14 at 14:20
1

FYI - `Paginator` is from `from django.core.paginator import Paginator`. – Chemical Programmer Dec 23 '15 at 17:42

score 1 · Answer 3 · answered Jan 11 '17 at 12:54

The methods of Malcolm Box and Deepak Prakash do can help to serializer the relathionship objects, but just as @eugene said before, it only works for a single Alum. For a Albums we can do this:

serializers.py

class TrackSerializer(serializers.ModelSerializer):
    class Meta:
        model = Track
        fields = ('order', 'title')

class AlbumSerializer(serializers.ModelSerializer):
    tracks = TrackSerializer(many=True)

    class Meta:
        model = Album
        fields = ('album_name', 'artist', 'tracks')
        depth=1

apis.py

class getAPIView(generics.ListAPIView):
    serializer_class=TrackSerializer
    filter_backends = (filters.OrderingFilter,)
    def get_queryset(self):
        queryset=Track.objects.all()
        return queryset
    def list(self, request, *args, **kwargs):
        queryset = self.filter_queryset(self.get_queryset())
        page = self.paginate_queryset(queryset)
        serializer = self.get_serializer(page, many=True)
        data=serializer.data
        albums=Album.objects.values_list('album_name').all()
        trackObjs=[]
        albumObjs=[]
        self.categoryKeyList(albums,albumObjs)
        if page is not None:
            for p in page:
                for n,i in enumerate(albums):
                     if re.search(str(p.alum),str(i)):
                        albumObjs[n]['track'].append(p)
        data={}
        data['count']=self.get_paginated_response(self).data['count']
        data['next']=self.get_paginated_response(self).data['next']
        data['previous']=self.get_paginated_response(self).data['previous']
        data['pageNumber'] = self.paginator.page.number
        data['countPage'] = self.paginator.page.paginator._count
        serializer=ClientsCategorySerializer(categoryObjs,many=True)
        data['result']=serializer.data
        return Response({'data':data,'success':'1','detail':u'获得客户列表成功'})
    def categoryKeyList(self,albums,albumObjs):
        for i in albums:
            albumObjs={}
            albumObjs['album_name']=i[0]
            track=[]
            albumObj['track']=track
            albumObjs.append(albumObj)

Then u may will get the response:

{
    data[
     {
          'album_name': 'The Grey Album',
          'tracks': [
                   {'order': 1, 'title': 'Public Service Annoucement'},
                   {'order': 2, 'title': 'What More Can I Say'},
                   {'order': 3, 'title': 'Encore'},
                      ...

      },
      {'album_name': 'The John Album',
          'tracks': [
                   {'order': 1, 'title': 'Public Annoucement'},
                   {'order': 2, 'title': 'What sd Can I Say'},
                   {'order': 3, 'title': 'sd'},
                      ...
},
 ......
}

Paginate relationship in Django REST Framework?

3 Answers3

Linked