web

Documentation

Index

• func RespondError(w http.ResponseWriter, err error)
• func RespondErrorMessage(w http.ResponseWriter, code int, message string)
• func RespondJSON(w http.ResponseWriter, status int, payload interface{})
• func RespondJSONWithXTotalCount(w http.ResponseWriter, status int, count int, payload interface{})
• func UnmarshalJSON(r *http.Request, target interface{}) error
• type HTTPError
  • func NewHTTPError(err string, httpStatus int) HTTPError
  • func (err HTTPError) Error() string
• type ValidationError
  • func NewValidationError(err string, failedValidations map[string]string) ValidationError
  • func (e ValidationError) Error() string

Functions

func RespondError

func RespondError(w http.ResponseWriter, err error)

RespondError returns a validation error else

func RespondErrorMessage

func RespondErrorMessage(w http.ResponseWriter, code int, message string)

RespondErrorMessage makes the error response with payload as json format

func RespondJSON

func RespondJSON(w http.ResponseWriter, status int, payload interface{})

RespondJSON makes the response with payload as json format

func RespondJSONWithXTotalCount

func RespondJSONWithXTotalCount(w http.ResponseWriter, status int, count int, payload interface{})

RespondJSONWithXTotalCount makes the response with payload as json format and adds X-Total-Count header

func UnmarshalJSON

func UnmarshalJSON(r *http.Request, target interface{}) error

UnmarshalJSON checks for empty body and then parses JSON into the target

Types

type HTTPError

type HTTPError struct {
	HTTPStatus int
	ErrorKey   string
}

HTTPError Represent an error to be sent back on repsonse

func NewHTTPError

func NewHTTPError(err string, httpStatus int) HTTPError

NewHTTPError creates an new instance of HTTP Error

func (HTTPError) Error

func (err HTTPError) Error() string

Error returns the error string

type ValidationError

type ValidationError struct {
	ErrorKey string            `json:"errorKey"`
	Errors   map[string]string `json:"errors"`
}

ValidationError is an error indicating error in validations

func NewValidationError

func NewValidationError(err string, failedValidations map[string]string) ValidationError

NewValidationError creates an new instance of Validation Error

func (ValidationError) Error

func (e ValidationError) Error() string