restype

README

restype

Convenient and strongly typed HTTP requests using resty client.

Documentation

Index

• Constants
• func Do[R Request[T], T any, E error](client *resty.Client, req R, opts ...RequestOptions) (t T, err error)
• func DoRaw[R Request[T], T any, E error](client *resty.Client, req R, opts ...RequestOptions) (res *resty.Response, t T, err error)
• type Default
  • func (Default) Body() ([]byte, error)
  • func (Default) Headers() map[string]string
  • func (Default) PathParams() map[string]string
  • func (Default) QueryParams() map[string]string
  • func (Default) ResponseFromBytes([]byte) (any, error)
• type Error
  • func (e Error) Error() string
  • func (e Error) Is(target error) bool
  • func (e Error) Unwrap() error
• type ErrorKind
  • func (e ErrorKind) Error() string
• type Request
• type RequestOptions

Constants

const (
	ErrorBodyFromRequest = iota
	ErrorExecuteRequest
	ErrorResponseFromBytes
)

Functions

func Do

func Do[R Request[T], T any, E error](client *resty.Client, req R, opts ...RequestOptions) (t T, err error)

Do performs a request using resty.Client with request of type `Request[T]`, response of type `T`, error of type `error`.

Requests without response should specify the `any` type. Requests without typed error should specify the `error` type.

RequestOptions enable modification of the request.

func DoRaw

func DoRaw[R Request[T], T any, E error](client *resty.Client, req R, opts ...RequestOptions) (res *resty.Response, t T, err error)

DoRaw performs the same function as Do and returns the raw resty.Response.

Types

type Default

type Default struct{}

Default is a convenience struct for embedding that provides default (nil) implementation of optional Request[T] methods.

func (Default) Body

func (Default) Body() ([]byte, error)

func (Default) Headers

func (Default) Headers() map[string]string

func (Default) PathParams

func (Default) PathParams() map[string]string

func (Default) QueryParams

func (Default) QueryParams() map[string]string

func (Default) ResponseFromBytes

func (Default) ResponseFromBytes([]byte) (any, error)

type Error

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

func (Error) Error

func (e Error) Error() string

func (Error) Is

func (e Error) Is(target error) bool

func (Error) Unwrap

func (e Error) Unwrap() error

type ErrorKind

type ErrorKind int

func (ErrorKind) Error

func (e ErrorKind) Error() string

type Request

type Request[T any] interface {
	Method() string
	Path() string
	PathParams() map[string]string
	QueryParams() map[string]string
	Headers() map[string]string
	Body() ([]byte, error)
	ResponseFromBytes([]byte) (T, error)
}

Request[T] represents a request with a response of type T.

type RequestOptions

type RequestOptions func(*resty.Request) *resty.Request

RequestOptions are functions that modify resty.Request and return a reference to it.

Allows for modifying the request where required or where it does not make sense to add to implementations of Request[T].