Working with Paginated Responses in Go

Working with Paginated Responses

Welcome back on your journey of mastering API interactions with Go! Building on your existing knowledge, today we will delve into API pagination . Pagination is a crucial concept for efficiently managing and retrieving large datasets through APIs. It allows you to request data in smaller, more manageable chunks instead of receiving all the data at once, which can be overwhelming and inefficient. Pagination is commonly used in scenarios involving extensive datasets, such as user lists or product catalogs, ensuring resources are used effectively and enhancing the application's performance.

Understanding Pagination Parameters

When you're dealing with a lot of data from an API, pagination is your friend. It helps you break down a massive dataset into smaller pieces that are easier to handle. To make this possible, there are two key settings you need to know about: page : This tells you which chunk of data you're looking at. Think of it as turning the page in a book to see the next set of information. limit : This controls how many items you see on each page, like deciding how many lines appear on each page of the book. By adjusting these parameters, you can control the flow of data retrieval. This lesson will build on what you've already learned about API requests, teaching you how to use these pagination settings effectively.

Fetching Paginated Data: Step-by-Step Example

Fetching paginated data involves several key steps. Below, we break down the process into smaller steps, explaining what each function does and how they work together to retrieve paginated data efficiently.

Step 1: Defining the Data Structure

Before fetching data, we need to define a struct that matches the JSON response from the API. This ensures the retrieved data can be correctly stored and used in Go. Go type Todo struct {ID int `json:"id"` Title string `json:"title"` Done bool `json:"done"`} ID stores the task’s unique identifier. Title represents the task’s description. Done tracks whether the task has been completed.

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Step 4: Fetching a Single Page

This function builds the request URL, sends the HTTP request, and processes the response.

func fetchTodosPage(baseURL string, page int) ([]Todo, error) {
    // Construct the request URL with query parameters
    reqURL, err := url.Parse(fmt.Sprintf("%s/todos", baseURL))
    if err != nil {
        return nil, fmt.Errorf("error parsing URL: %w", err)
    }

    query := reqURL.Query()
    query.Set("page", fmt.Sprintf("%d", page))
    query.Set("limit", "3")
    reqURL.RawQuery = query.Encode()

    // Send the GET request
    resp, err := http.Get(reqURL.String())
    if err != nil {
        return nil, fmt.Errorf("error making request: %w", err)
    }
    defer resp.Body.Close()

    if resp.StatusCode != http.StatusOK {
        return nil, fmt.Errorf("HTTP error: %s", resp.Status)
    }

    var pageTodos []Todo
    if err := json.NewDecoder(resp.Body).Decode(&pageTodos); err != nil {
        return nil, fmt.Errorf("error decoding JSON: %w", err)
    }

    return pageTodos, nil
}

func fetchTodosPage(baseURL string, page int) ([]Todo, error) {
    // Construct the request URL with query parameters
    reqURL, err := url.Parse(fmt.Sprintf("%s/todos", baseURL))
    if err != nil {
        return nil, fmt.Errorf("error parsing URL: %w", err)
    }

    query := reqURL.Query()
    query.Set("page", fmt.Sprintf("%d", page))
    query.Set("limit", "3")
    reqURL.RawQuery = query.Encode()

    // Send the GET request
    resp, err := http.Get(reqURL.String())
    if err != nil {
        return nil, fmt.Errorf("error making request: %w", err)
    }
    defer resp.Body.Close()

    if resp.StatusCode != http.StatusOK {
        return nil, fmt.Errorf("HTTP error: %s", resp.Status)
    }

    var pageTodos []Todo
    if err := json.NewDecoder(resp.Body).Decode(&pageTodos); err != nil {
        return nil, fmt.Errorf("error decoding JSON: %w", err)
    }

    return pageTodos, nil
}

Uses url.Parse from the net/url to build the request URL.
Adds page and limit as query parameters.
Sends a GET request using http.Get.
Decodes the JSON response into a list of Todo items.

Step 6: The Complete Flow

Now that we have examined each function, let's summarize the overall flow:

main() initializes the process and calls fetchAllTodos().
fetchAllTodos() iterates through pages, requesting one page at a time.
fetchTodosPage() constructs and sends the HTTP request, handling API responses.
If data is returned, printTodos() displays it.
The process continues until all pages are fetched.

By following these structured steps, we ensure efficient data retrieval while keeping the code modular and readable.

Here's the full code:

package main

import (
    "encoding/json"
    "fmt"
    "net/http"
    "net/url"
)

type Todo struct {
    ID    int    `json:"id"`
    Title string `json:"title"`
    Done  bool   `json:"done"`
}

func main() {
    baseURL := "http://localhost:8000"
    fetchAllTodos(baseURL)
}

func fetchAllTodos(baseURL string) {
    page := 1 // Start from the first page

    for {
        todos, err := fetchTodosPage(baseURL, page)
        if err != nil {
            fmt.Printf("Error fetching page %d: %v\n", page, err)
            break
        }

        if len(todos) == 0 { // Exit loop if no more data
            break
        }

        fmt.Printf("Page %d fetched successfully!\n", page)
        printTodos(todos)

        page++ // Advance to next page
    }
}

func fetchTodosPage(baseURL string, page int) ([]Todo, error) {
    // Construct the request URL with query parameters
    reqURL, err := url.Parse(fmt.Sprintf("%s/todos", baseURL))
    if err != nil {
        return nil, fmt.Errorf("error parsing URL: %w", err)
    }

    // Set the Query parameters
    query := reqURL.Query()
    query.Set("page", fmt.Sprintf("%d", page))
    query.Set("limit", "3")
    reqURL.RawQuery = query.Encode()

    // Send the GET request
    resp, err := http.Get(reqURL.String())
    if err != nil {
        return nil, fmt.Errorf("error making request: %w", err)
    }
    defer resp.Body.Close()

    if resp.StatusCode != http.StatusOK {
        return nil, fmt.Errorf("HTTP error: %s", resp.Status)
    }

    var pageTodos []Todo
    if err := json.NewDecoder(resp.Body).Decode(&pageTodos); err != nil {
        return nil, fmt.Errorf("error decoding JSON: %w", err)
    }

    return pageTodos, nil
}

func printTodos(todos []Todo) {
    for _, todo := range todos {
        fmt.Printf("- ID: %d: %s (Done: %t)\n", todo.ID, todo.Title, todo.Done)
    }
}

package main

import (
    "encoding/json"
    "fmt"
    "net/http"
    "net/url"
)

type Todo struct {
    ID    int    `json:"id"`
    Title string `json:"title"`
    Done  bool   `json:"done"`
}

func main() {
    baseURL := "http://localhost:8000"
    fetchAllTodos(baseURL)
}

func fetchAllTodos(baseURL string) {
    page := 1 // Start from the first page

    for {
        todos, err := fetchTodosPage(baseURL, page)
        if err != nil {
            fmt.Printf("Error fetching page %d: %v\n", page, err)
            break
        }

        if len(todos) == 0 { // Exit loop if no more data
            break
        }

        fmt.Printf("Page %d fetched successfully!\n", page)
        printTodos(todos)

        page++ // Advance to next page
    }
}

func fetchTodosPage(baseURL string, page int) ([]Todo, error) {
    // Construct the request URL with query parameters
    reqURL, err := url.Parse(fmt.Sprintf("%s/todos", baseURL))
    if err != nil {
        return nil, fmt.Errorf("error parsing URL: %w", err)
    }

    // Set the Query parameters
    query := reqURL.Query()
    query.Set("page", fmt.Sprintf("%d", page))
    query.Set("limit", "3")
    reqURL.RawQuery = query.Encode()

    // Send the GET request
    resp, err := http.Get(reqURL.String())
    if err != nil {
        return nil, fmt.Errorf("error making request: %w", err)
    }
    defer resp.Body.Close()

    if resp.StatusCode != http.StatusOK {
        return nil, fmt.Errorf("HTTP error: %s", resp.Status)
    }

    var pageTodos []Todo
    if err := json.NewDecoder(resp.Body).Decode(&pageTodos); err != nil {
        return nil, fmt.Errorf("error decoding JSON: %w", err)
    }

    return pageTodos, nil
}

func printTodos(todos []Todo) {
    for _, todo := range todos {
        fmt.Printf("- ID: %d: %s (Done: %t)\n", todo.ID, todo.Title, todo.Done)
    }
}

When working with paginated API data, you can begin retrieving data from any page, which offers flexibility in managing how data is requested and processed. Here’s a streamlined overview of how to effectively use parameters, implement loops for multiple requests, and determine when to stop fetching data.

Parameters Setup:
- Start by setting the page variable to the desired starting point (e.g., page = 1). The page parameter designates the specific segment of data to retrieve, while the limit parameter (e.g., limit = 3) specifies how many items to fetch per request. These parameters are crucial for navigating through different sections of the dataset.
Implementing the Loop:
- Utilize a for loop to continuously request data, iterating through pages. For each iteration, pass the current page number as a parameter in the API request to obtain the corresponding data segment.
Data Retrieval and Loop Termination:
- Convert the API response to JSON format to process the data. If the response is empty, which means there is no more data to retrieve, exit the loop.
- When data is present, handle and display it as needed, then increment the page variable to proceed to the next data segment. Repeat this process until all data has been collected.

By utilizing this method, you can efficiently manage large datasets, segmenting the data retrieval process into manageable requests.