Pagination metadata in response in Rest API - Mini Project: Build & Apply

Pagination metadata in response

📖 Scenario: You are building a simple REST API that returns a list of products. To help clients navigate through many products, you want to add pagination metadata in the response.

🎯 Goal: Create a REST API response that includes a list of products and pagination metadata such as current page, total pages, and total items.

📋 What You'll Learn

Create a list called products with exactly these product names: "Apple", "Banana", "Cherry", "Date", "Elderberry"

Create a variable called page_size and set it to 2

Create a variable called current_page and set it to 2

Create a dictionary called pagination_metadata with keys current_page, total_pages, and total_items

Create a dictionary called response with keys products and pagination

Print the response dictionary

💡 Why This Matters

🌍 Real World

APIs often return large lists of data. Pagination metadata helps clients know how many pages exist and which page they are viewing.

💼 Career

Understanding pagination metadata is important for backend developers building APIs and frontend developers consuming paginated data.

1

Create the products list

Create a list called products with these exact product names: "Apple", "Banana", "Cherry", "Date", "Elderberry"

Rest API

# Create the products list
# Your code here

Hint

Use square brackets [] to create a list and include the product names as strings separated by commas.

2

Set pagination variables

Create a variable called page_size and set it to 2. Create a variable called current_page and set it to 2.

Rest API

products = ["Apple", "Banana", "Cherry", "Date", "Elderberry"]
# Create page_size and current_page variables
# Your code here

Hint

Use simple assignment to create the variables with the exact names and values.

3

Create pagination metadata dictionary

Create a dictionary called pagination_metadata with keys current_page, total_pages, and total_items. Set current_page to the variable current_page, total_items to the length of products, and total_pages to the total number of pages calculated by dividing total items by page size and rounding up.

Rest API

products = ["Apple", "Banana", "Cherry", "Date", "Elderberry"]
page_size = 2
current_page = 2
# Create pagination_metadata dictionary
# Your code here

Hint

Use the math.ceil() function to round up the total pages.

4

Create response dictionary and print it

Create a dictionary called response with keys products and pagination. Set products to the list products and pagination to the dictionary pagination_metadata. Then print the response dictionary.

Rest API

products = ["Apple", "Banana", "Cherry", "Date", "Elderberry"]
page_size = 2
current_page = 2
import math
pagination_metadata = {
    "current_page": current_page,
    "total_items": len(products),
    "total_pages": math.ceil(len(products) / page_size)
}
# Create response dictionary and print it
# Your code here

Hint

Use a dictionary with the exact keys and values, then print it.

Practice

1.

What is the main purpose of including pagination metadata in a REST API response?

easy

A. To inform the client about the current page and total pages available

B. To encrypt the data for security reasons

C. To compress the response size for faster transmission

D. To validate the user's authentication token

Solution

1. Step 1: Understand pagination metadata role

   Pagination metadata provides information about the current page, total pages, and items per page to help clients navigate large data sets.

2. Step 2: Identify the correct purpose

   Among the options, only informing the client about page details matches the role of pagination metadata.

3. Final Answer:

   To inform the client about the current page and total pages available -> Option A

4. Quick Check:

   Pagination metadata = page info [OK]

Hint: Pagination metadata tells page info, not security or compression [OK]

Common Mistakes:

• Confusing pagination metadata with security features
• Thinking it compresses data
• Assuming it validates user tokens

2.

Which of the following is the correct JSON structure for pagination metadata in a REST API response?

{
  "data": [...],
  "pagination": {
    "current_page": 1,
    "total_pages": 5,
    "per_page": 10
  }
}

easy

A. { "pagination": "page 1 of 5" }

B. { "page": 1, "pages": 5, "size": 10 }

C. { "pagination": [1, 5, 10] }

D. { "pagination": { "current_page": 1, "total_pages": 5, "per_page": 10 } }

Solution

1. Step 1: Check JSON structure for pagination metadata

   The correct structure uses a nested object with keys like current_page, total_pages, and per_page to clearly describe pagination details.

2. Step 2: Compare options to the example

   { "pagination": { "current_page": 1, "total_pages": 5, "per_page": 10 } } matches the example with a nested object and descriptive keys, while others use incorrect formats or data types.

3. Final Answer:

   { "pagination": { "current_page": 1, "total_pages": 5, "per_page": 10 } } -> Option D

4. Quick Check:

   Pagination metadata = nested object with page info [OK]

Hint: Look for nested object with clear keys for pagination [OK]

Common Mistakes:

• Using arrays instead of objects for metadata
• Using strings instead of structured data
• Omitting descriptive keys

3.

Given this REST API response snippet, what is the value of response.pagination.total_pages?

{
  "data": [{"id":1}, {"id":2}],
  "pagination": {
    "current_page": 2,
    "total_pages": 4,
    "per_page": 2
  }
}

medium

A. 2

B. 4

C. 1

D. Undefined

Solution

1. Step 1: Locate the total_pages key in the response

   Within the pagination object, total_pages is set to 4.

2. Step 2: Confirm the value of total_pages

   The value 4 indicates the total number of pages available in the data set.

3. Final Answer:

   4 -> Option B

4. Quick Check:

   total_pages = 4 [OK]

Hint: Find total_pages key inside pagination object [OK]

Common Mistakes:

• Confusing current_page with total_pages
• Assuming total_pages is the length of data array
• Missing the nested pagination object

4.

Identify the error in this pagination metadata snippet and select the fix:

{
  "data": [...],
  "pagination": {
    "currentPage": 1,
    "totalPages": 3,
    "perPage": 10
  }
}

medium

A. Remove the pagination object completely

B. Change values to strings instead of numbers

C. Change keys to snake_case: current_page, total_pages, per_page

D. Add a new key called page_count

Solution

1. Step 1: Check key naming conventions in pagination metadata

   Standard REST API pagination metadata uses snake_case keys like current_page, total_pages, and per_page for consistency.

2. Step 2: Identify the fix for camelCase keys

   Changing currentPage, totalPages, perPage to snake_case fixes the inconsistency and aligns with common API practices.

3. Final Answer:

   Change keys to snake_case: current_page, total_pages, per_page -> Option C

4. Quick Check:

   Use snake_case keys for pagination metadata [OK]

Hint: Use snake_case keys for pagination metadata [OK]

Common Mistakes:

• Leaving camelCase keys in metadata
• Removing pagination metadata entirely
• Changing numeric values to strings unnecessarily

5.

You have an API returning 45 items with per_page set to 10. How many pages should the total_pages metadata show?

hard

A. 5

B. 6

C. 4

D. 10

Solution

1. Step 1: Calculate total pages from total items and per_page

   Total pages = total items divided by items per page, rounded up. Here, 45 / 10 = 4.5, rounded up to 5.

2. Step 2: Confirm the correct total_pages value

   Since 4 pages would only cover 40 items, 5 pages are needed to cover all 45 items.

3. Final Answer:

   5 -> Option A

4. Quick Check:

   Ceil(45/10) = 5 pages [OK]

Hint: Divide total items by per_page, round up [OK]

Common Mistakes:

• Using floor division instead of ceiling
• Ignoring leftover items on last page
• Assuming total_pages equals per_page