rest

Documentation

Index

• Variables
• func IsAPIError(err error) bool
• func IsBadRequest(err error) bool
• func IsClientError(err error) bool
• func IsConflict(err error) bool
• func IsServerError(err error) bool
• type Client
  • func NewClient(config Config) *Client
  • func (c *Client) Do(ctx context.Context, method, path string, headers map[string]string, ...) error
• type Config

Variables

var (
	ErrAPIError = errors.New("api error")
	ErrClient   = fmt.Errorf("%w: client error", ErrAPIError)
	ErrServer   = fmt.Errorf("%w: server error", ErrAPIError)
)

var (
	ErrBadRequest = fmt.Errorf("%w: validation failed", ErrClient)
	ErrConflict   = fmt.Errorf("%w: conflict", ErrClient)
)

Functions

func IsAPIError

func IsAPIError(err error) bool

func IsBadRequest

func IsBadRequest(err error) bool

func IsClientError

func IsClientError(err error) bool

func IsConflict

func IsConflict(err error) bool

func IsServerError

func IsServerError(err error) bool

Types

type Client

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

func NewClient

func NewClient(config Config) *Client

func (*Client) Do

func (c *Client) Do(ctx context.Context, method, path string, headers map[string]string, payload, response any) error

type Config

type Config struct {
	Client  *http.Client // Optional HTTP Client, defaults to `http.DefaultClient`
	BaseURL string       // Optional base URL
}