Introduction to Error Handling in API Requests with Go

Welcome to the first lesson of Efficient API Interactions with Go. In this course, you will learn how to handle common scenarios when working with APIs more effectively. One of the key aspects of working with APIs is error handling. Handling errors gracefully not only helps in building robust applications but also enhances the user experience by providing meaningful feedback when things go wrong. Our goal in this lesson is to help you manage these outcomes effectively.

When you send a request to an API, the server responds with an HTTP status code. These codes indicate the result of your request. Understanding them is essential for effective error handling. Here's a brief overview:

• 2xx (Success): Indicates that the request was successfully received, understood, and accepted. For example, a 200 status code means OK.
• 4xx (Client Errors): Suggests that there was an error in the request made by your client. For example, 404 means the requested resource was not found.
• 5xx (Server Errors): Indicates that the server failed to fulfill a valid request. A common code here is 500, which means an internal server error.

By paying attention to these codes, you can determine whether your request succeeded or if there was a problem that needs addressing.

In Go, error handling is done by checking the response StatusCode and handling errors accordingly. Unlike other languages that use exceptions, Go relies on explicit error checking using conditional statements.

Consider the following example, which fetches todo items from an API:

package main

import (
    "errors"
    "fmt"
    "io/ioutil"
    "net/http"
)

func fetchTodos(apiURL string) error {
    resp, err := http.Get(apiURL)
    if err != nil {
        return fmt.Errorf("request error: %w", err)
    }
    defer resp.Body.Close()

    // Check if the response has a 4xx or 5xx status code
    if resp.StatusCode >= 400 {
        return errors.New(fmt.Sprintf("HTTP error occurred: %s", resp.Status))
    }

    // Read response body
    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        return fmt.Errorf("error reading response body: %w", err)
    }

    fmt.Println("Todos fetched successfully!")
    fmt.Println(string(body))
    return nil
}

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

    // Call fetchTodos and handle any returned errors
    if err := fetchTodos(baseURL); err != nil {
        fmt.Println("Error:", err)
    }
}

In this example, we check the StatusCode of the response and handle any errors by printing an appropriate message if it falls within the 4xx or 5xx range. This approach ensures clear and effective error handling, making it easier to identify and troubleshoot issues in your application. To improve modularity and reusability, we encapsulate this logic within a dedicated function (fetchTodos), allowing for better organization and easier management of API requests and error handling separately.

Additionally, we use errors.New() to create well-formatted error messages, making it clear when something goes wrong. Instead of merely printing errors, we return them, enabling better error propagation and handling in real applications. This approach provides more flexibility in dealing with failures, making Go applications more robust and maintainable.