diff options
| author | Tom Christie | 2012-10-01 16:17:01 +0100 |
|---|---|---|
| committer | Tom Christie | 2012-10-01 16:17:01 +0100 |
| commit | 8d1d99018725469061d5696a5552e7ebdb5cccc9 (patch) | |
| tree | 03af8aa34445b9b7715f2c89a41bd6199c33c684 /docs/api-guide | |
| parent | 1d432cf4327d5c4cdee323310cc80c5f111f0a23 (diff) | |
| download | django-rest-framework-8d1d99018725469061d5696a5552e7ebdb5cccc9.tar.bz2 | |
Pagination docs
Diffstat (limited to 'docs/api-guide')
| -rw-r--r-- | docs/api-guide/pagination.md | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/docs/api-guide/pagination.md b/docs/api-guide/pagination.md index 0f0a32b5..6211a0ac 100644 --- a/docs/api-guide/pagination.md +++ b/docs/api-guide/pagination.md @@ -8,7 +8,7 @@ REST framework includes a `PaginationSerializer` class that makes it easy to return paginated data in a way that can then be rendered to arbitrary media types. -## Examples +## Paginating basic data Let's start by taking a look at an example from the Django documentation. @@ -35,6 +35,8 @@ The `context` argument of the `PaginationSerializer` class may optionally includ We could now return that data in a `Response` object, and it would be rendered into the correct media type. +## Paginating QuerySets + Our first example worked because we were using primative objects. If we wanted to paginate a queryset or other complex data, we'd need to specify a serializer to use to serialize the result set itself with. We can do this using the `object_serializer_class` attribute on the inner `Meta` class of the pagination serializer. For example. @@ -83,16 +85,20 @@ You can also set the pagination style on a per-view basis, using the `ListAPIVie pagination_serializer_class = CustomPaginationSerializer paginate_by = 10 +For more complex requirements such as serialization that differs depending on the requested media type you can override the `.get_paginate_by()` and `.get_pagination_serializer_class()` methods. + ## Creating custom pagination serializers -Override `pagination.BasePaginationSerializer`, and set the fields that you want the serializer to return. +To create a custom pagination serializer class you should override `pagination.BasePaginationSerializer` and set the fields that you want the serializer to return. + +For example, to nest a pair of links labelled 'prev' and 'next' you might use something like this. -For example. + class LinksSerializer(serializers.Serializer): + next = pagination.NextURLField(source='*') + prev = pagination.PreviousURLField(source='*') class CustomPaginationSerializer(pagination.BasePaginationSerializer): - next = pagination.NextURLField() + links = LinksSerializer(source='*') # Takes the page object as the source total_results = serializers.Field(source='paginator.count') - [cite]: https://docs.djangoproject.com/en/dev/topics/pagination/ - |
