rest_framework_json_api.pagination module¶
Pagination fields
-
class
rest_framework_json_api.pagination.
JsonApiPageNumberPagination
¶ Bases:
rest_framework.pagination.PageNumberPagination
A json-api compatible pagination format.
-
page_query_param
= 'page[number]'¶
-
page_size_query_param
= 'page[size]'¶
-
max_page_size
= 100¶
-
build_link
(index)¶
-
get_paginated_response
(data)¶
-
-
class
rest_framework_json_api.pagination.
JsonApiLimitOffsetPagination
¶ Bases:
rest_framework.pagination.LimitOffsetPagination
A limit/offset based style. For example:
http://api.example.org/accounts/?page[limit]=100 http://api.example.org/accounts/?page[offset]=400&page[limit]=100
-
limit_query_param
= 'page[limit]'¶
-
offset_query_param
= 'page[offset]'¶
-
max_limit
= 100¶
-
get_last_link
()¶
-
get_first_link
()¶
-
get_paginated_response
(data)¶
-
-
class
rest_framework_json_api.pagination.
PageNumberPagination
¶ Bases:
rest_framework_json_api.pagination.JsonApiPageNumberPagination
Warning
PageNumberPagination is deprecated. Use JsonApiPageNumberPagination instead. If you want to retain current defaults you will need to implement custom pagination class explicitly setting page_query_param = “page” and page_size_query_param = “page_size”. See changelog for more details.
A paginator that uses non-JSON:API query parameters (default: ‘page’ and ‘page_size’ instead of ‘page[number]’ and ‘page[size]’).
-
page_query_param
= 'page'¶
-
page_size_query_param
= 'page_size'¶
-
-
class
rest_framework_json_api.pagination.
LimitOffsetPagination
¶ Bases:
rest_framework_json_api.pagination.JsonApiLimitOffsetPagination
Warning
LimitOffsetPagination is deprecated. Use JsonApiLimitOffsetPagination instead. If you want to retain current defaults you will need to implement custom pagination class explicitly setting max_limit = None. See changelog for more details.
A paginator that uses a different max_limit from JsonApiLimitOffsetPagination.
-
max_limit
= None¶
-