rest

Documentation

Overview

Package rest provides service-wide utils and convenience helpers to be used in cross-service requests

Index

• func CopyHeader(dst *http.Header, src http.Header)
• func Decode(r io.Reader, v any) error
• func DecodeCustom(d Decoder, r io.Reader, v any) error
• func Encode(w io.Writer, data any) error
• func EncodeCustom(e Encoder, w io.Writer, data any) error
• func JSONRequest(ctx context.Context, method string, url string, input any, output any, ...) (int, error)
• func JSONResponse(w http.ResponseWriter, resp *Response, code int)
• func JSONResponseRaw(w http.ResponseWriter, payload any, code int)
• func Marshal(v any) ([]byte, error)
• func MarshalCustom(m Marshaler, v any) ([]byte, error)
• func ServeBadRequest(w http.ResponseWriter, err string)
• func ServeBadRequestMalformedPayload(w http.ResponseWriter)
• func ServeInternalServerError(w http.ResponseWriter, err string)
• func ServeNotFound(w http.ResponseWriter, err string)
• func ServeOKResponseJSON(w http.ResponseWriter, r *http.Request, res any)
• func SetDefaultSerializer(s Serializer)
• func Unmarshal(data []byte, v any) error
• func UnmarshalCustom(u Unmarshaler, data []byte, v any) error
• type Decoder
• type Encoder
• type ErrorCode
• type Marshaler
• type RawResponse
  • func (r *RawResponse) Close()
• type RequestFailedError
  • func NewRequestCreationError(method string, url string, payload io.Reader, err error) *RequestFailedError
  • func NewRequestExecutionError(method string, url string, payload io.Reader, err error) *RequestFailedError
  • func NewRequestParsingError(method string, url string, requestPayload io.Reader, responsePayload io.Reader, ...) *RequestFailedError
  • func (e *RequestFailedError) Error() string
  • func (e *RequestFailedError) Is(target error) bool
  • func (e *RequestFailedError) LogValue() slog.Value
  • func (e *RequestFailedError) Unwrap() error
• type RequestOption
  • func WithAdditionalHeaders(h http.Header) RequestOption
  • func WithCheckRetry(cr retryablehttp.CheckRetry) RequestOption
  • func WithClient(c *http.Client) RequestOption
  • func WithDecoder(d Decoder) RequestOption
  • func WithEncoder(e Encoder) RequestOption
  • func WithHeaders(h http.Header) RequestOption
  • func WithRetries(r int) RequestOption
  • func WithSerializer(s Serializer) RequestOption
• type Response
• type ResponseStatus
• type Serializer
  • func DefaultSerializer() Serializer
• type Unmarshaler

Functions

func CopyHeader

func CopyHeader(dst *http.Header, src http.Header)

func Decode

func Decode(r io.Reader, v any) error

func DecodeCustom

func DecodeCustom(d Decoder, r io.Reader, v any) error

func Encode

func Encode(w io.Writer, data any) error

func EncodeCustom

func EncodeCustom(e Encoder, w io.Writer, data any) error

func JSONRequest

func JSONRequest(
	ctx context.Context,
	method string,
	url string,
	input any,
	output any,
	errorResp any,
	opts ...RequestOption,
) (int, error)

func JSONResponse

func JSONResponse(w http.ResponseWriter, resp *Response, code int)

func JSONResponseRaw

func JSONResponseRaw(w http.ResponseWriter, payload any, code int)

func Marshal

func Marshal(v any) ([]byte, error)

func MarshalCustom

func MarshalCustom(m Marshaler, v any) ([]byte, error)

func ServeBadRequest

func ServeBadRequest(w http.ResponseWriter, err string)

func ServeBadRequestMalformedPayload

func ServeBadRequestMalformedPayload(w http.ResponseWriter)

func ServeInternalServerError

func ServeInternalServerError(w http.ResponseWriter, err string)

func ServeNotFound

func ServeNotFound(w http.ResponseWriter, err string)

func ServeOKResponseJSON

func ServeOKResponseJSON(w http.ResponseWriter, r *http.Request, res any)

ServeOKResponseJSON serves http.StatusOK Response with provided payload, optionally handling ETag match

Will serve http.StatusNotModified with no body if provided ETag is equal to computed, otherwise will serve http.StatusOK with body.

func SetDefaultSerializer

func SetDefaultSerializer(s Serializer)

func Unmarshal

func Unmarshal(data []byte, v any) error

func UnmarshalCustom

func UnmarshalCustom(u Unmarshaler, data []byte, v any) error

Types

type Decoder

type Decoder interface {
	Decode(r io.Reader, dst any) error
}

type Encoder

type Encoder interface {
	Encode(w io.Writer, src any) error
}

type ErrorCode

type ErrorCode string

const (
	InternalServerErrorCode ErrorCode = "INTERNAL_SERVER_ERROR"
	BadRequestErrorCode     ErrorCode = "BAD_REQUEST"
	NotFoundErrorCode       ErrorCode = "NOT_FOUND"
	TimeoutErrorCode        ErrorCode = "TIMEOUT"
	UnauthorizedErrorCode   ErrorCode = "UNAUTHORIZED"
	ForbiddenErrorCode      ErrorCode = "FORBIDDEN"
	InvalidSessionErrorCode ErrorCode = "INVALID_SESSION"
	ConflictErrorCode       ErrorCode = "CONFLICT"
)

type Marshaler

type Marshaler interface {
	Marshal(data any) ([]byte, error)
}

type RawResponse

type RawResponse struct {
	Status int
	Body   *bytes.Buffer
	Header http.Header
	// contains filtered or unexported fields
}

func (*RawResponse) Close

func (r *RawResponse) Close()

type RequestFailedError

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

func NewRequestCreationError

func NewRequestCreationError(
	method string,
	url string,
	payload io.Reader,
	err error,
) *RequestFailedError

func NewRequestExecutionError

func NewRequestExecutionError(
	method string,
	url string,
	payload io.Reader,
	err error,
) *RequestFailedError

func NewRequestParsingError

func NewRequestParsingError(
	method string,
	url string,
	requestPayload io.Reader,
	responsePayload io.Reader,
	err error,
) *RequestFailedError

func (*RequestFailedError) Error

func (e *RequestFailedError) Error() string

func (*RequestFailedError) Is

func (e *RequestFailedError) Is(target error) bool

func (*RequestFailedError) LogValue

func (e *RequestFailedError) LogValue() slog.Value

func (*RequestFailedError) Unwrap

func (e *RequestFailedError) Unwrap() error

type RequestOption

type RequestOption func(*requestOptions)

func WithAdditionalHeaders

func WithAdditionalHeaders(h http.Header) RequestOption

func WithCheckRetry

func WithCheckRetry(cr retryablehttp.CheckRetry) RequestOption

func WithClient

func WithClient(c *http.Client) RequestOption

func WithDecoder

func WithDecoder(d Decoder) RequestOption

func WithEncoder

func WithEncoder(e Encoder) RequestOption

func WithHeaders

func WithHeaders(h http.Header) RequestOption

func WithRetries

func WithRetries(r int) RequestOption

func WithSerializer

func WithSerializer(s Serializer) RequestOption

type Response

type Response struct {
	Status    ResponseStatus `json:"status"`
	ErrorCode ErrorCode      `json:"errorCode,omitempty"`
	Error     string         `json:"error,omitempty"`
	Payload   any            `json:"payload,omitempty"`
}

type ResponseStatus

type ResponseStatus string

const (
	APIResponseStatusOk    ResponseStatus = "ok"
	APIResponseStatusError ResponseStatus = "error"
)

type Serializer

type Serializer interface {
	Marshaler
	Unmarshaler
	Encoder
	Decoder
}

func DefaultSerializer

func DefaultSerializer() Serializer

type Unmarshaler

type Unmarshaler interface {
	Unmarshal(data []byte, dst any) error
}