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

Need a 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

Need a 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

Need a 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

Need a hint?

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