Testing a Paginated REST API

Paginated APIs are a common architectural pattern for handling large datasets. They break down responses into smaller, manageable chunks, improving performance and user experience. However, testing these APIs requires a strategic approach to ensure – 
✅ All pages return the correct data
✅ The pagination logic works correctly (e.g., next, previous links)
✅ The API adheres to performance constraints

In this guide, we’ll cover:
1️⃣ Understanding API Pagination
2️⃣ Validating Pagination with Python & Pytest
3️⃣  Performance Testing for Pagination
4️⃣ Handling Edge Cases & Errors
5️⃣ Best Practices & Further Resources

🚀 1. Understanding API Pagination

Typically, a paginated API uses parameters like:

• page: The current page number.
• pageSize (or limit): The number of items per page.
• totalItems (or totalCount): The total number of items in the dataset.
• totalPages: The total number of pages.
• nextPage (or next): A URL or identifier for the next page.
• previousPage (or prev): A URL or identifier for the previous page.

# Paginated API response

{
  "data": [
    {"id": 1, "name": "Item 1"},
    {"id": 2, "name": "Item 2"}
  ],
  "meta": {
    "total": 100,
    "per_page": 2,
    "current_page": 1,
    "next_page": 2,
    "prev_page": null
  }
}

✅ 2. Validating Pagination with Pytest

# pip install requests pytest

BASE_URL = "https://api.example.com/items"
PAGE_SIZE = 10  # Number of items per page

# Fetch all pages until no more data
import requests
import pytest
from config import BASE_URL, PAGE_SIZE

def test_api_pagination():
    page = 1
    all_items = []
    
    while True:
        response = requests.get(f"{BASE_URL}?page={page}&limit={PAGE_SIZE}")

        # Verify status code 200 for all pages
        assert response.status_code == 200, f"API request failed on page {page}"
        
        # Validate response structure
        data = response.json()
        assert "data" in data and isinstance(data["data"], list), "Invalid response structure"
        
        all_items.extend(data["data"])
        
        # Ensure all pages are retrieved. Stop if no more data.
        if not data["data"] or "next_page" not in data["meta"]:
            break

        page += 1  # Move to next page

    assert len(all_items) > 0, "No data retrieved"

🔍 3. Performance Testing for Pagination

import time

def test_pagination_performance():
    page = 1
    total_time = 0
    
    while True:
        start_time = time.time()
        response = requests.get(f"{BASE_URL}?page={page}&limit={PAGE_SIZE}")
        end_time = time.time()
        
        assert response.status_code == 200
        total_time += (end_time - start_time)

        data = response.json()
        if not data["data"]:
            break  # Stop when there's no more data

        page += 1

    assert total_time < 5, f"API took too long: {total_time} seconds"

⚠ 4. Handling Edge Cases & Errors

# Invalid Page Requests
@pytest.mark.parametrize("page_number", [-1, 0, "invalid"])
def test_invalid_page_numbers(page_number):
    response = requests.get(f"{BASE_URL}?page={page_number}&limit={PAGE_SIZE}")
    assert response.status_code == 400 or response.status_code == 422, "API should return a validation error"


# Large Page sizes (Performance Check)
def test_large_page_size():
    response = requests.get(f"{BASE_URL}?page=1&limit=10000")  # Unusually large limit
    assert response.status_code == 200, "API should handle large limits gracefully"
    assert len(response.json().get("data", [])) <= 10000, "API returned more items than allowed"

📌 5. Best Practices for API Pagination Testing

✅ Test with different limit values (small & large)
✅ Validate next_page & prev_page links for proper navigation
✅ Measure API performance for large datasets
✅ Handle unexpected scenarios (invalid pages, missing fields)
✅ Use parallel execution (pytest-xdist) to speed up tests

Implementing Automated Tests: A Step-by-Step Approach

1. Basic Connectivity and Structure Tests:

   • Start with basic tests to ensure the API endpoint is reachable and returns a valid JSON response.
   • Verify the presence of pagination-related fields (e.g., page, pageSize, totalItems).

2. Retrieving and Validating the First Page:

   • Make a request to the API without any pagination parameters (or with page=1).
   • Validate the pageSize and the number of items returned.
   • Verify the data structure and content of the items on the first page.

3. Iterating Through All Pages:

   • This is the core of paginated API testing. Implement a loop that:
     • Retrieves the nextPage URL (or calculates the next page number).
     • Makes a request to the next page.
     • Validates the pageSize and the number of items returned.
     • Verifies the data structure and content of the items on the current page.
     • The loop should continue until the nextPage is null, or the current page number is equal to the totalPages value.
   • Alternatively, if the API does not provide a next page url, you can increment the page number and continue the loop until a response with an empty array is received.

4. Validating Total Item Count:

   • After iterating through all pages, verify that the sum of items across all pages matches the totalItems value.
   • This is a critical step to ensure no data is lost during pagination.

5. Data Consistency Checks:

   • Implement tests to ensure data consistency across pages.
   • For example, if the API returns a list of users, verify that no user appears on multiple pages.
   • If items are returned in a specific order, confirm that the order is consistent across the pages.

6. Edge Case Testing:

   • Test edge cases, such as:
     • Requesting a page number that does not exist.
     • Requesting a pageSize that is too large or too small.
     • Requesting a page with invalid parameters.
     • Requesting the first and last page.
   • Verify that the API returns appropriate error codes and messages.

7. Performance Testing:

   • Measure the response time for each page request.
   • Identify any performance bottlenecks related to pagination.

Tools and Technologies

• Programming Languages: Python (with requests library), JavaScript (with axios or fetch), Java (with RestAssured).
• Testing Frameworks: PyTest, JUnit, Mocha, Jest.
• API Testing Tools: Postman, Insomnia.

📚 Further Reading & Resources

🔗 Popular Resources

• REST API Pagination: https://www.restapitutorial.com/lessons/pagination.html
• Testing REST APIs with Python: https://realpython.com/python-api-testing/

🎯 Underrated Resources

• API Load Testing with Locust
• Rate Limiting & Pagination
• Advanced API Testing Techniques: https://www.guru99.com/api-testing.html
• Web API design: https://learn.microsoft.com/en-us/azure/architecture/best-practices/api-design 

📌 GitHub Repositories for API Testing

• Pytest API Testing Examples
• REST API Pagination Example
• Load Testing APIs with Locust

🤖 AI-Powered Tools for API Testing

• Postman AI – Auto-generates test cases for API validation
• K6 AI Load Testing – Simulates API traffic & pagination performance
• TestRigor – AI-powered API automation testing
• AI-Powered Test Data Generation: Tools like Synthetics can generate realistic test data for paginated APIs, ensuring comprehensive coverage.
• AI-Driven Anomaly Detection: Tools like AppDynamics or Dynatrace can monitor API performance and detect anomalies in pagination behavior.
• AI for Test Case Optimization: Tools which use machine learning to analyse test results, and provide suggestions on how to improve test coverage and reduce redundancy.

0 0 votes

Article Rating

Subscribe

Login

Notify of

new follow-up commentsnew replies to my comments

Label

{} [+]

Name*

Email*

Δ

Label

{} [+]

Name*

Email*

Δ

0 Comments

Oldest

Newest Most Voted