common

Documentation

Index

• Constants
• Variables
• func BindAndValidateRequest(c echo.Context, req Validatable) bool
• func ErrorResponse(c echo.Context, status string) error
• func NotFoundResponse(c echo.Context, message string) error
• func QueryLimit(c echo.Context) (int, error)
• func QueryReverseOrder(c echo.Context) (bool, error)
• func UUID(c echo.Context, param string) (uuid.UUID, error)
• func ValidationErrorItemResponse(c echo.Context, field, message string, args ...any) error
• func ValidationErrorResponse(c echo.Context, reason any) error
• func WrapErrorItem(item *model.ErrorResponseItem) error
• type PaginationQuery
  • func QueryPagination(c echo.Context) (PaginationQuery, error)
• type Validatable

Constants

const (
	ParamQueryLimit        = "limit"
	ParamQueryCursor       = "cursor"
	ParamQueryReserveOrder = "reverseOrder"
)

const StatusInternalError = "internal_error"

Variables

var (
	ErrLimitInvalid        = errors.New("invalid limit")
	ErrReverseOrderInvalid = errors.New("invalid reverseOrder")
)

Functions

func BindAndValidateRequest

func BindAndValidateRequest(c echo.Context, req Validatable) bool

func ErrorResponse

func ErrorResponse(c echo.Context, status string) error

func NotFoundResponse

func NotFoundResponse(c echo.Context, message string) error

func QueryLimit

func QueryLimit(c echo.Context) (int, error)

func QueryReverseOrder

func QueryReverseOrder(c echo.Context) (bool, error)

func UUID

func UUID(c echo.Context, param string) (uuid.UUID, error)

UUID parsed uuid from request's path or query. If failed, writes validation error response.

func ValidationErrorItemResponse

func ValidationErrorItemResponse(c echo.Context, field, message string, args ...any) error

func ValidationErrorResponse

func ValidationErrorResponse(c echo.Context, reason any) error

func WrapErrorItem

func WrapErrorItem(item *model.ErrorResponseItem) error

Types

type PaginationQuery

type PaginationQuery struct {
	Limit       int
	Cursor      string
	ReverseSort bool
}

func QueryPagination

func QueryPagination(c echo.Context) (PaginationQuery, error)

type Validatable

type Validatable interface {
	Validate(formats strfmt.Registry) error
}