api

Documentation

Index

• Constants
• Variables
• func Duplicated(v []string) bool
• func FromJsonBody[T Validable](r io.ReadCloser) (T, error)
• func FromUrlParams[T Parseable[T]](r *http.Request, name string) (T, error)
• func FromUrlQuery[T Parseable[T]](r *http.Request, name string, fallback T) (T, error)
• func HandlerFunc(f ApiFunction) http.HandlerFunc
• func MakeHttpError(err error) error
• func MakeServiceError(err error) error
• func WithInterval(i IntervalParams, column string) func(db *gorm.DB) *gorm.DB
• func WithMaximumBodySize(n int64) func(http.Handler) http.Handler
• func WithPagination(p PaginationParams) func(db *gorm.DB) *gorm.DB
• func WriteJson(w http.ResponseWriter, statusCode int, v any) error
• type ApiError
  • func (ae ApiError) Error() string
• type ApiFunction
• type IntervalParams
• type PaginatedResponse
  • func MakePaginatedResponse(v any, count int64, p PaginationParams) *PaginatedResponse
• type PaginationMetadata
• type PaginationParams
• type Parseable
• type Validable

Constants

const (
	MaxUploadSize   = 2 * (1 << 20) // 2MB
	DefaultBodySize = 1 << 18       // 256KB

)

Variables

var (
	ErrNotFound      = errors.New("not found")
	ErrNotAZip       = errors.New("file is not a valid zip")
	ErrDuplicatedKey = errors.New("already exists")
	ErrInvalidParam  = errors.New("invalid param")
)

Functions

func Duplicated

func Duplicated(v []string) bool

func FromJsonBody

func FromJsonBody[T Validable](r io.ReadCloser) (T, error)

func FromUrlParams

func FromUrlParams[T Parseable[T]](r *http.Request, name string) (T, error)

func FromUrlQuery

func FromUrlQuery[T Parseable[T]](r *http.Request, name string, fallback T) (T, error)

func HandlerFunc

func HandlerFunc(f ApiFunction) http.HandlerFunc

func MakeHttpError

func MakeHttpError(err error) error

func MakeServiceError

func MakeServiceError(err error) error

func WithInterval

func WithInterval(i IntervalParams, column string) func(db *gorm.DB) *gorm.DB

func WithMaximumBodySize

func WithMaximumBodySize(n int64) func(http.Handler) http.Handler

func WithPagination

func WithPagination(p PaginationParams) func(db *gorm.DB) *gorm.DB

func WriteJson

func WriteJson(w http.ResponseWriter, statusCode int, v any) error

Types

type ApiError

type ApiError struct {
	Message string `json:"message"`
	// contains filtered or unexported fields
}

ApiError represents the http error returned by the REST service. Implements error interface.

func (ApiError) Error

func (ae ApiError) Error() string

type ApiFunction

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

type IntervalParams

type IntervalParams struct {
	Start time.Time
	End   time.Time
}

type PaginatedResponse

type PaginatedResponse struct {
	Data     any                `json:"data"`
	Metadata PaginationMetadata `json:"metadata"`
}

func MakePaginatedResponse

func MakePaginatedResponse(v any, count int64, p PaginationParams) *PaginatedResponse

type PaginationMetadata

type PaginationMetadata struct {
	HasNext  bool  `json:"hasNext"`
	Count    int64 `json:"count"`
	Page     int64 `json:"page"`
	PageSize int64 `json:"pageSize"`
}

type PaginationParams

type PaginationParams struct {
	Page     int64
	PageSize int64
}

type Parseable

type Parseable[T any] interface {
	Parse(s string) (T, error)
}

type Validable

type Validable interface {
	Validate() error
}