go.astrophena.name/base/request

go.astrophena.name/base Module

Base Go packages for my projects.

package request

import "go.astrophena.name/base/request"

Package request provides a simplified way to make HTTP requests, especially for JSON APIs.

Index

Examples

Variables

var DefaultClient = &http.Client{
	Timeout: 10 * time.Second,
}

DefaultClient is the default http.Client used by Make.

It has a timeout of 10 seconds to prevent requests from hanging indefinitely.

Functions

func Make

func Make[Response any](ctx context.Context, p Params) (Response, error)

Make sends an HTTP request and tries to parse the JSON response.

The Response type parameter determines how the response body is handled:

If Response is IgnoreResponse, the response body is ignored and no parsing is attempted.
Otherwise, the response body is expected to be JSON and is unmarshaled into a variable of type Response.

It returns the parsed response of type Response and an error if the request fails or parsing fails. For non-200 status codes, it returns an error containing the status code and response body.

Example

package main

import (
	"context"
	"log"
	"net/http"

	"go.astrophena.name/base/request"
)

func main() {
	type response struct {
		OK     bool `json:"ok"`
		Checks map[string]struct {
			Status string `json:"status"`
			OK     bool   `json:"ok"`
		} `json:"checks"`
	}

	// Checking health of Starlet.
	health, err := request.Make[response](context.Background(), request.Params{
		Method: http.MethodGet,
		URL:    "https://bot.astrophena.name/health",
	})
	if err != nil {
		log.Fatal(err)
	}

	if health.OK {
		log.Println("Alive.")
	} else {
		log.Printf("Not alive: %+v", health)
	}
}

Example (Scrub)

package main

import (
	"context"
	"fmt"
	"log"
	"net/http"
	"os"
	"strings"

	"go.astrophena.name/base/request"
)

func main() {
	// Making request to GitHub API, scrubbing token out of error messages.
	user, err := request.Make[map[string]any](context.Background(), request.Params{
		Method: http.MethodGet,
		URL:    "https://api.github.com/user",
		Headers: map[string]string{
			"Authorization": "Bearer " + os.Getenv("GITHUB_TOKEN"),
		},
		Scrubber: strings.NewReplacer(os.Getenv("GITHUB_TOKEN"), "[EXPUNGED]"),
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(user["login"])
}

Types

type IgnoreResponse

type IgnoreResponse struct{}

IgnoreResponse is a type to use with Make to skip JSON unmarshaling of the response body.

type Params

type Params struct {
	// Method is the HTTP method (GET, POST, etc.) for the request.
	Method string
	// URL is the target URL of the request.
	URL string
	// Headers is a map of key-value pairs for additional request headers.
	Headers map[string]string
	// Body is any data to be sent in the request body. It will be marshaled to
	// JSON or, if it's type is url.Values, as query string with Content-Type
	// header set to "application/x-www-form-urlencoded".
	Body any
	// HTTPClient is an optional custom http.Client to use for the request.
	// If not provided, DefaultClient will be used.
	HTTPClient *http.Client
	// Scrubber is an optional strings.Replacer that scrubs unwanted data from
	// error messages.
	Scrubber *strings.Replacer
}

Params defines the parameters needed for making an HTTP request.