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

Adjusted pagination X headers in example, moved out get_first/last_link methods

Browse Source
This commit is contained in:
Steve Lacey 2015-02-27 17:40:15 +00:00
parent 3dc83fb458
commit f3efdce9ed
1 changed files with 14 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -101,35 +101,30 @@ from rest_framework.utils.urls import remove_query_param, replace_query_param
class LinkHeaderPagination(pagination.PageNumberPagination):
def get_paginated_response(self, data):
headers = {
'X-Page': self.page.number,
'X-Per-Page': self.page.paginator.per_page,
'X-Total': self.page.paginator.count,
'X-Total-Pages': self.page.paginator.num_pages
}
first_url = self.get_first_link()
prev_url = self.get_previous_link()
next_url = self.get_next_link()
last_url = self.get_last_link()
link = '<{}>; rel="{}"'
links = []
links = [
link.format(first_url, 'first'),
link.format(prev_url, 'prev') if prev_url else None,
link.format(next_url, 'next') if next_url else None,
link.format(last_url, 'last'),
]
if first_url: links.append(link.format(first_url, 'first'))
if prev_url: links.append(link.format(prev_url, 'prev'))
if next_url: links.append(link.format(next_url, 'next'))
if last_url: links.append(link.format(last_url, 'last'))
headers = {
'Link': ", ".join([link for link in links if link]),
'X-Total-Count': self.page.paginator.count
}
if links:
headers['Link'] = ", ".join(links)
return Response(data, headers=headers)
def get_first_link(self):
url = self.request.build_absolute_uri()
return remove_query_param(url, self.page_query_param)
def get_last_link(self):
url = self.request.build_absolute_uri()
page_number = self.page.paginator.num_pages
return replace_query_param(url, self.page_query_param, page_number)
```
## Using your custom pagination class