http

README

HTTP Client Package

This package provides a common HTTP client with standardized headers and error handling for Buildkite API requests.

Features

• Standardized authorization header handling
• Common error handling for API responses
• Support for different HTTP methods (GET, POST, PUT, DELETE)
• JSON request and response handling
• Configurable base URL and user agent

Usage

Creating a client

import (
    "github.com/buildkite/cli/v3/internal/http"
)

// Basic client with token
client := http.NewClient("your-api-token")

// Client with custom base URL
client := http.NewClient(
    "your-api-token",
    http.WithBaseURL("https://api.example.com"),
)

// Client with custom user agent
client := http.NewClient(
    "your-api-token",
    http.WithUserAgent("my-app/1.0"),
)

// Client with custom HTTP client
client := http.NewClient(
    "your-api-token",
    http.WithHTTPClient(customHTTPClient),
)

Making requests

// GET request
var response SomeResponseType
err := client.Get(ctx, "/endpoint", &response)

// POST request with body
requestBody := map[string]string{"key": "value"}
var response SomeResponseType
err := client.Post(ctx, "/endpoint", requestBody, &response)

// PUT request
err := client.Put(ctx, "/endpoint", requestBody, &response)

// DELETE request
err := client.Delete(ctx, "/endpoint", &response)

// Custom method
err := client.Do(ctx, "PATCH", "/endpoint", requestBody, &response)

Error handling

err := client.Get(ctx, "/endpoint", &response)
if err != nil {
    // Check if it's an HTTP error
    if httpErr, ok := err.(*http.ErrorResponse); ok {
        fmt.Printf("HTTP error: %d %s\n", httpErr.StatusCode, httpErr.Status)
        fmt.Printf("Response body: %s\n", httpErr.Body)
    } else {
        fmt.Printf("Other error: %v\n", err)
    }
}

Documentation

Index

• type Client
  • func NewClient(token string, opts ...ClientOption) *Client
  • func (c *Client) Delete(ctx context.Context, endpoint string, v interface{}) error
  • func (c *Client) Do(ctx context.Context, method, endpoint string, body interface{}, v interface{}) error
  • func (c *Client) Get(ctx context.Context, endpoint string, v interface{}) error
  • func (c *Client) Post(ctx context.Context, endpoint string, body interface{}, v interface{}) error
  • func (c *Client) Put(ctx context.Context, endpoint string, body interface{}, v interface{}) error
• type ClientOption
  • func WithBaseURL(baseURL string) ClientOption
  • func WithHTTPClient(client *http.Client) ClientOption
  • func WithUserAgent(userAgent string) ClientOption
• type ErrorResponse
  • func (e *ErrorResponse) Error() string
  • func (e *ErrorResponse) IsBadRequest() bool
  • func (e *ErrorResponse) IsForbidden() bool
  • func (e *ErrorResponse) IsNotFound() bool
  • func (e *ErrorResponse) IsServerError() bool
  • func (e *ErrorResponse) IsUnauthorized() bool

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is an HTTP client that handles common operations for Buildkite API requests

func NewClient

func NewClient(token string, opts ...ClientOption) *Client

NewClient creates a new HTTP client with the given token and options

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, endpoint string, v interface{}) error

Delete performs a DELETE request to the specified endpoint

func (*Client) Do

func (c *Client) Do(ctx context.Context, method, endpoint string, body interface{}, v interface{}) error

Do performs an HTTP request with the given method, endpoint, and body

func (*Client) Get

func (c *Client) Get(ctx context.Context, endpoint string, v interface{}) error

Get performs a GET request to the specified endpoint

func (*Client) Post

func (c *Client) Post(ctx context.Context, endpoint string, body interface{}, v interface{}) error

Post performs a POST request to the specified endpoint with the given body

func (*Client) Put

func (c *Client) Put(ctx context.Context, endpoint string, body interface{}, v interface{}) error

Put performs a PUT request to the specified endpoint with the given body

type ClientOption

type ClientOption func(*Client)

ClientOption is a function that modifies a Client

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL sets the base URL for API requests

func WithHTTPClient

func WithHTTPClient(client *http.Client) ClientOption

WithHTTPClient sets the underlying HTTP client

func WithUserAgent

func WithUserAgent(userAgent string) ClientOption

WithUserAgent sets the User-Agent header for requests

type ErrorResponse

type ErrorResponse struct {
	StatusCode int
	Status     string
	URL        string
	Body       []byte
}

ErrorResponse represents an error response from the API

func (*ErrorResponse) Error

func (e *ErrorResponse) Error() string

Error implements the error interface

func (*ErrorResponse) IsBadRequest

func (e *ErrorResponse) IsBadRequest() bool

IsBadRequest returns true if the error is a 400 Bad Request

func (*ErrorResponse) IsForbidden

func (e *ErrorResponse) IsForbidden() bool

IsForbidden returns true if the error is a 403 Forbidden

func (*ErrorResponse) IsNotFound

func (e *ErrorResponse) IsNotFound() bool

IsNotFound returns true if the error is a 404 Not Found

func (*ErrorResponse) IsServerError

func (e *ErrorResponse) IsServerError() bool

IsServerError returns true if the error is a 5xx Server Error

func (*ErrorResponse) IsUnauthorized

func (e *ErrorResponse) IsUnauthorized() bool

IsUnauthorized returns true if the error is a 401 Unauthorized