client

Documentation

Index

• Constants
• func HTTPClient() *http.Client
• type Option
  • func WithBaseURL(s string) Option
  • func WithHTTPClient(c *http.Client) Option
  • func WithHeader(k, v string) Option
  • func WithHeaders(h http.Header) Option
  • func WithLogger(l *slog.Logger) Option
  • func WithMaxResponseBytes(n int64) Option
• type REST
  • func New(opts ...Option) *REST
  • func (c *REST) Process(ctx context.Context, req *http.Request, out any) error

Constants

const DefaultMaxResponseBytes int64 = 32 << 20 // 32 MiB

DefaultMaxResponseBytes caps response body reads. Set via WithMaxResponseBytes; pass 0 to disable the cap entirely.

Functions

func HTTPClient

func HTTPClient() *http.Client

Types

type Option

type Option func(*REST)

Option configures a REST client.

func WithBaseURL

func WithBaseURL(s string) Option

WithBaseURL sets a base URL that relative request URLs are resolved against. Absolute request URLs are passed through unchanged.

func WithHTTPClient

func WithHTTPClient(c *http.Client) Option

WithHTTPClient overrides the underlying *http.Client.

func WithHeader

func WithHeader(k, v string) Option

WithHeader sets a default header applied to every request. Per-request headers already set on the *http.Request take precedence.

func WithHeaders

func WithHeaders(h http.Header) Option

WithHeaders merges the given headers into the default header set.

func WithLogger

func WithLogger(l *slog.Logger) Option

WithLogger overrides the slog.Logger used for request logging.

func WithMaxResponseBytes

func WithMaxResponseBytes(n int64) Option

WithMaxResponseBytes caps the number of response body bytes read into memory. Pass 0 to disable the cap.

type REST

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

REST is an embeddable HTTP client for REST APIs. Concrete clients embed *REST and expose typed methods that build an *http.Request and call Process.

func New

func New(opts ...Option) *REST

New creates a REST client with the given options. By default it uses HTTPClient() (retrying, OTel-instrumented), an empty header set, a discard logger, and a DefaultMaxResponseBytes response cap.

func (*REST) Process

func (c *REST) Process(ctx context.Context, req *http.Request, out any) error

Process sends req and writes the response into out, choosing how based on the type of out:

• nil: response body is discarded.
• *[]byte: raw bytes.
• *string: raw string.
• io.Writer: streamed via io.Copy.
• anything else: JSON-decoded.

Non-2xx responses return an *errors.Error carrying the status code and body. Response body reads are capped by WithMaxResponseBytes (0 disables the cap). The response body is always closed.