encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-08-06 13:30:12 +03:00
Code Issues Packages Projects Releases Wiki Activity

Stripped indent now using a code block

Browse Source
This commit is contained in:
Steve Lacey 2015-02-27 16:33:00 +00:00
parent ace82b78d6
commit 29c8146c00
1 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
docs/api-guide/pagination.md
View File

@ -86,42 +86,42 @@ Note that the `paginate_queryset` method may set state on the pagination instanc
Let's modify the built-in `PageNumberPagination` style, so that instead of include the pagination links in the body of the response, we'll instead include a `Link` header, in a [similar style to the GitHub API][github-link-pagination]. Let's modify the built-in `PageNumberPagination` style, so that instead of include the pagination links in the body of the response, we'll instead include a `Link` header, in a [similar style to the GitHub API][github-link-pagination].
```py ```py
from rest_framework.pagination import PageNumberPagination from rest_framework.pagination import PageNumberPagination
from rest_framework.response import Response from rest_framework.response import Response
from rest_framework.utils.urls import remove_query_param, replace_query_param from rest_framework.utils.urls import remove_query_param, replace_query_param
class LinkHeaderPagination(pagination.PageNumberPagination): class LinkHeaderPagination(pagination.PageNumberPagination):
def get_paginated_response(self, data): def get_paginated_response(self, data):
first_url = self.get_first_link() first_url = self.get_first_link()
prev_url = self.get_previous_link() prev_url = self.get_previous_link()
next_url = self.get_next_link() next_url = self.get_next_link()
last_url = self.get_last_link() last_url = self.get_last_link()
link = '<{}>; rel="{}"' link = '<{}>; rel="{}"'
links = [ links = [
link.format(first_url, 'first'), link.format(first_url, 'first'),
link.format(prev_url, 'prev') if prev_url else None, link.format(prev_url, 'prev') if prev_url else None,
link.format(next_url, 'next') if next_url else None, link.format(next_url, 'next') if next_url else None,
link.format(last_url, 'last'), link.format(last_url, 'last'),
] ]
headers = { headers = {
'Link': ", ".join([link for link in links if link]), 'Link': ", ".join([link for link in links if link]),
'X-Total-Count': self.page.paginator.count 'X-Total-Count': self.page.paginator.count
} }
return Response(data, headers=headers) return Response(data, headers=headers)
def get_first_link(self): def get_first_link(self):
url = self.request.build_absolute_uri() url = self.request.build_absolute_uri()
return remove_query_param(url, self.page_query_param) return remove_query_param(url, self.page_query_param)
def get_last_link(self): def get_last_link(self):
url = self.request.build_absolute_uri() url = self.request.build_absolute_uri()
page_number = self.page.paginator.num_pages page_number = self.page.paginator.num_pages
return replace_query_param(url, self.page_query_param, page_number) return replace_query_param(url, self.page_query_param, page_number)
``` ```
## Using your custom pagination class ## Using your custom pagination class