rest_framework_json_api.pagination module

Pagination fields

class rest_framework_json_api.pagination.JsonApiPageNumberPagination

Bases: 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: 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)