apihelper

Documentation

Index

• func GetAllUrlQueryValues[T any](query url.Values, valueKey string, parser Parser[T]) (*[]T, error)
• func GetContextValue[T any](ctx context.Context, valueKey string) (*T, error)
• func GetUrlQueryValue[T any](query url.Values, valueKey string, parser Parser[T]) (*T, error)
• func HandlePing() func(w http.ResponseWriter, r *http.Request)
• func MapUuidHeader(header string) func(next http.Handler) http.Handler
• func MapUuidQueries(w http.ResponseWriter, r *url.URL, query string, trg *[]uuid.UUID) error
• func UnmarshalJsonAndValidate(logger *zap.SugaredLogger, rw http.ResponseWriter, r *http.Request, ...) bool
• func UnmarshalJsonAndValidateWithError(rw http.ResponseWriter, r *http.Request, data interface{}) error
• func WriteCreateRessourceResponse(w http.ResponseWriter, r *http.Request, id uuid.UUID)
• type CreateRessourceResponse
• type GetContextValueError
  • func (m *GetContextValueError) Error() string
  • func (m *GetContextValueError) GetStandardisedError() *standardisedError.StandardisedError
• type GetUrlQueryValueError
  • func (m *GetUrlQueryValueError) Error() string
  • func (m *GetUrlQueryValueError) GetStandardisedError() *standardisedError.StandardisedError
• type HandlerFuncWithError
• type Parser
• type UrlQueryTypes

Functions

func GetAllUrlQueryValues

func GetAllUrlQueryValues[T any](query url.Values, valueKey string, parser Parser[T]) (*[]T, error)

func GetContextValue

func GetContextValue[T any](ctx context.Context, valueKey string) (*T, error)

func GetUrlQueryValue

func GetUrlQueryValue[T any](query url.Values, valueKey string, parser Parser[T]) (*T, error)

func HandlePing

func HandlePing() func(w http.ResponseWriter, r *http.Request)

func MapUuidHeader

func MapUuidHeader(header string) func(next http.Handler) http.Handler

func MapUuidQueries

func MapUuidQueries(w http.ResponseWriter, r *url.URL, query string, trg *[]uuid.UUID) error

func UnmarshalJsonAndValidate

func UnmarshalJsonAndValidate(logger *zap.SugaredLogger, rw http.ResponseWriter, r *http.Request, data interface{}) bool

returns true when unmarshal succeeded, otherwise writes error to response and returns false expects a pointer to a dto

func UnmarshalJsonAndValidateWithError

func UnmarshalJsonAndValidateWithError(rw http.ResponseWriter, r *http.Request, data interface{}) error

expects a pointer to a dto

func WriteCreateRessourceResponse

func WriteCreateRessourceResponse(w http.ResponseWriter, r *http.Request, id uuid.UUID)

Types

type CreateRessourceResponse

type CreateRessourceResponse struct {
	ID *uuid.UUID `json:"id"`
}

type GetContextValueError

type GetContextValueError struct {
	standardisedError.StandardisedError
	Param string `json:"param"`
}

define custom error to catch later in withErrorHandler

func (*GetContextValueError) Error

func (m *GetContextValueError) Error() string

func (*GetContextValueError) GetStandardisedError

func (m *GetContextValueError) GetStandardisedError() *standardisedError.StandardisedError

type GetUrlQueryValueError

type GetUrlQueryValueError struct {
	standardisedError.StandardisedError
	Param string `json:"param"`
}

define custom error to catch later in withErrorHandler

func (*GetUrlQueryValueError) Error

func (m *GetUrlQueryValueError) Error() string

func (*GetUrlQueryValueError) GetStandardisedError

func (m *GetUrlQueryValueError) GetStandardisedError() *standardisedError.StandardisedError

type HandlerFuncWithError

type HandlerFuncWithError func(http.ResponseWriter, *http.Request) error

type Parser

type Parser[T any] interface {
	Parse(string) (*T, error)
}

type UrlQueryTypes

type UrlQueryTypes interface {
	string | int64 | float64 | uuid.UUID
}