leafHttpResponse

Documentation

Index

• Constants
• func NewJSONResponse(eCtx echo.Context, statusCode int, data interface{}) error
• type BasePagingResponse
  • func (p BasePagingResponse) Val() interface{}
• type Error
• type ErrorField
• type ItemsResponse
• type PagingParams
• type PagingResponse
  • func (p PagingResponse) Val() interface{}
• type Response
• type SimplePagingResponse

Constants

const ApiResponse = "api-response"

Functions

func NewJSONResponse

func NewJSONResponse(
	eCtx echo.Context,
	statusCode int,
	data interface{},
) error

Types

type BasePagingResponse

type BasePagingResponse struct {
	Count       int          `json:"count"`
	CurrentPage int          `json:"currentPage"`
	TotalPage   int          `json:"totalPages"`
	Params      PagingParams `json:"params"`
}

func (BasePagingResponse) Val

func (p BasePagingResponse) Val() interface{}

type Error

type Error struct {
	Message string       `json:"message"`
	Code    int          `json:"code"`
	Errors  []ErrorField `json:"errors,omitempty"`
}

type ErrorField

type ErrorField struct {
	Field  string `json:"field"`
	Reason string `json:"reason"`
}

type ItemsResponse

type ItemsResponse struct {
	Items []interface{} `json:"items"`
}

type PagingParams

type PagingParams struct {
	Page   int         `json:"page"`
	Limit  int         `json:"limit"`
	Sort   []string    `json:"sort"`
	Filter interface{} `json:"filter,omitempty"`
}

type PagingResponse

type PagingResponse struct {
	Count       int          `json:"count"`
	CurrentPage int          `json:"currentPage"`
	TotalPage   int          `json:"totalPages"`
	Params      PagingParams `json:"params"`
	Items       interface{}  `json:"items"`
}

func (PagingResponse) Val

func (p PagingResponse) Val() interface{}

type Response

type Response interface {
	Val() interface{}
}

type SimplePagingResponse

type SimplePagingResponse struct {
	CurrentPage int          `json:"currentPage"`
	Next        bool         `json:"next"`
	Params      PagingParams `json:"params"`
}