api

Documentation

Index

• func ErrorResponse(c echo.Context, status int, err error) error
• func StandardResponse(c echo.Context, status int, res interface{}) error
• type StatusObject
  • func NewErrorStatus(s int, e error) StatusObject
  • func NewStatus(s int, m string) StatusObject
  • func (so *StatusObject) Error() string
  • func (so *StatusObject) String() string

Functions

func ErrorResponse

func ErrorResponse(c echo.Context, status int, err error) error

ErrorResponse reports the error and responds with an ErrorObject

func StandardResponse

func StandardResponse(c echo.Context, status int, res interface{}) error

StandardResponse is the default way to respond to API requests

Types

type StatusObject

type StatusObject struct {
	Status    int    `json:"status" binding:"required"`
	Message   string `json:"message" binding:"required"`
	RootError error  `json:"-"`
}

StatusObject is used to report operation status and errors in an API request. The struct can be used as a response object or be treated as an error object

func NewErrorStatus

func NewErrorStatus(s int, e error) StatusObject

NewErrorStatus initializes a new StatusObject from an error

func NewStatus

func NewStatus(s int, m string) StatusObject

NewStatus initializes a new StatusObject

func (*StatusObject) Error

func (so *StatusObject) Error() string

func (*StatusObject) String

func (so *StatusObject) String() string