httpclient

Documentation

Index

• type RefreshFunc
• type RequestRunner
  • func NewAuthenticatedClient(inner RequestRunner, apiToken, apiTokenHeaderName string) RequestRunner
  • func NewAuthenticatedClientWithRefresh(inner RequestRunner, apiToken, apiTokenHeaderName string, expiration time.Time, ...) RequestRunner
  • func NewClientWithBaseURL(inner RequestRunner, baseURL string) (RequestRunner, error)
  • func NewEventualConsistentClient(inner RequestRunner) RequestRunner
  • func NewLoggingClient(inner RequestRunner, logger *slog.Logger, ...) RequestRunner

Types

type RefreshFunc

type RefreshFunc func() (string, time.Time, error)

type RequestRunner

type RequestRunner interface {
	Do(*http.Request) (*http.Response, error)
}

RequestRunner is an abstraction for HTTP clients. The usual *http.Client type natively implements this interface; however, this interface also allows you to swap it client with your own implementation, if required.

func NewAuthenticatedClient

func NewAuthenticatedClient(inner RequestRunner, apiToken, apiTokenHeaderName string) RequestRunner

func NewAuthenticatedClientWithRefresh

func NewAuthenticatedClientWithRefresh(inner RequestRunner, apiToken, apiTokenHeaderName string, expiration time.Time, refreshFunc RefreshFunc) RequestRunner

func NewClientWithBaseURL

func NewClientWithBaseURL(inner RequestRunner, baseURL string) (RequestRunner, error)

func NewEventualConsistentClient

func NewEventualConsistentClient(inner RequestRunner) RequestRunner

NewEventualConsistentClient adds support for the eventual consistency behaviour as documented in 1 to a client.

func NewLoggingClient

func NewLoggingClient(inner RequestRunner, logger *slog.Logger, logRequestBodies, logResponseBodies bool) RequestRunner