{"id":6749,"date":"2023-08-24T07:16:43","date_gmt":"2023-08-24T07:16:43","guid":{"rendered":"https:\/\/www.pythontutorial.net\/?page_id=6749"},"modified":"2023-08-24T07:21:56","modified_gmt":"2023-08-24T07:21:56","slug":"django-rest-framework-pagination","status":"publish","type":"page","link":"https:\/\/www.pythontutorial.net\/django-tutorial\/django-rest-framework-pagination\/","title":{"rendered":"Django REST Framework Pagination"},"content":{"rendered":"\n

Summary<\/strong>: in this tutorial, you will learn how to use the Django REST Framework Pagination feature to divide a list of records into multiple pages.<\/p>\n\n\n\n

Introduction to Django REST Framework pagination #<\/a><\/h2>\n\n\n\n

Suppose you have thousands of records and want to show them to users. But the screen is quite limited. Therefore, you often need to break these records into pages, each containing 5 or 10 records.<\/p>\n\n\n\n

The pagination feature allows you to utilize the server resources more efficiently, improve the loading times, and enhance user experiences.<\/p>\n\n\n\n

Django REST Framework pagination allows you to split a large result set into individual pages with some simple settings.<\/p>\n\n\n\n

We’ll continue with the Todo API project from the previous tutorial. Let’s add some todos to the project to test out the pagination:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Django Pagination styles #<\/a><\/h2>\n\n\n\n

Django provides different styles to paginate data. Let’s explore them.<\/p>\n\n\n\n

Page number pagination #<\/a><\/h3>\n\n\n\n

The page number pagination style accepts a single page number in the request query parameters. You can jump to specific pages easily.<\/p>\n\n\n\n

To configure page number pagination, you add it to the REST_FRAMEWORK<\/code> in the settings.py<\/code> of the project.<\/p>\n\n\n\n

For example, the following instructs the DRF to use the PageNumberPagination<\/code> style with a page size of 2:<\/p>\n\n\n

REST_FRAMEWORK = {\n    # ...<\/span>\n    'DEFAULT_PAGINATION_CLASS'<\/span>: 'rest_framework.pagination.PageNumberPagination'<\/span>,\n    'PAGE_SIZE'<\/span>: 10<\/span>,\n}<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Once the setup is in place, you can make a GET<\/code> request to the endpoint \/api\/v1\/todos?page=2<\/code> in the web browser.<\/p>\n\n\n\n
Here’s the response:<\/p>\n\n\n
HTTP 200<\/span> OK\nAllow: GET, POST, HEAD, OPTIONS\nContent-Type: application\/json\nVary: Accept\n\n{\n    \"count\"<\/span>: 6<\/span>,\n    \"next\"<\/span>: \"http:\/\/localhost:8000\/api\/v1\/todos\/?page=3\"<\/span>,\n    \"previous\"<\/span>: \"http:\/\/localhost:8000\/api\/v1\/todos\/\"<\/span>,\n    \"results\"<\/span>: [\n        {\n            \"id\"<\/span>: 3<\/span>,\n            \"title\"<\/span>: \"Master Django REST API\"<\/span>,\n            \"completed\"<\/span>: false,\n            \"user\"<\/span>: \"john\"<\/span>\n        },\n        {\n            \"id\"<\/span>: 6<\/span>,\n            \"title\"<\/span>: \"Deploy API to Server\"<\/span>,\n            \"completed\"<\/span>: false,\n            \"user\"<\/span>: \"john\"<\/span>\n        }\n    ]\n}<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
In the response:<\/p>\n\n\n\n