web

Documentation

Index

• func ErrorResponse(c *gin.Context, code int, message string, causes ...Cause)
• func SuccessResponse(c *gin.Context, message string)
• type Cause
• type GenericResponse
• type Page
• type SearchParams
  • func ApplySearchParams(opts ...SearchParamsOpt) *SearchParams
  • func (opts SearchParams) Limit() int
  • func (opts SearchParams) NumberOfPages(recordsCount int64) int
  • func (opts SearchParams) Offset() int
• type SearchParamsOpt
  • func Filters(filters map[string]string) SearchParamsOpt
  • func Pagination(pageNumber int, pageSize int) SearchParamsOpt
  • func Sorting(sortBy string, reverse bool) SearchParamsOpt

Functions

func ErrorResponse

func ErrorResponse(c *gin.Context, code int, message string, causes ...Cause)

func SuccessResponse

func SuccessResponse(c *gin.Context, message string)

Types

type Cause

type Cause = map[string]string

type GenericResponse

type GenericResponse struct {
	Status  string  `json:"status"`
	Message string  `json:"message"`
	Causes  []Cause `json:"causes,omitempty"`
}

type Page

type Page struct {
	PageNumber int `json:"pageNumber"`
	PageSize   int `json:"pageSize"`
	TotalPages int `json:"totalPages"`
}

type SearchParams

type SearchParams struct {
	PageNumber  int
	PageSize    int
	SortBy      string
	ReverseSort bool
	Filters     map[string]string
}

func ApplySearchParams

func ApplySearchParams(opts ...SearchParamsOpt) *SearchParams

func (SearchParams) Limit

func (opts SearchParams) Limit() int

func (SearchParams) NumberOfPages

func (opts SearchParams) NumberOfPages(recordsCount int64) int

func (SearchParams) Offset

func (opts SearchParams) Offset() int

type SearchParamsOpt

type SearchParamsOpt = func(*SearchParams)

func Filters

func Filters(filters map[string]string) SearchParamsOpt

func Pagination

func Pagination(pageNumber int, pageSize int) SearchParamsOpt

func Sorting

func Sorting(sortBy string, reverse bool) SearchParamsOpt