response

Documentation

Index

• Variables
• func BadRequest(w http.ResponseWriter, message string)
• func Error(w http.ResponseWriter, err error)
• func Forbidden(w http.ResponseWriter, message string)
• func InternalServerError(w http.ResponseWriter, err error)
• func NotFound(w http.ResponseWriter, message string)
• func OK(w http.ResponseWriter, data any)
• func Raw(w http.ResponseWriter, status int, data any, headers map[string]string)
• func Unauthorized(w http.ResponseWriter, message string)
• type Response
• type StatusError
  • func NewStatusError(status int, err error) *StatusError
  • func NewStatusErrorMessage(status int, message string) *StatusError
  • func NewStatusErrorf(status int, format string, args ...any) *StatusError
  • func (e StatusError) Error() string

Variables

var ServerError = InternalServerError

Functions

func BadRequest

func BadRequest(w http.ResponseWriter, message string)

func Error

func Error(w http.ResponseWriter, err error)

func Forbidden

func Forbidden(w http.ResponseWriter, message string)

func InternalServerError

func InternalServerError(w http.ResponseWriter, err error)

func NotFound

func NotFound(w http.ResponseWriter, message string)

func OK

func OK(w http.ResponseWriter, data any)

func Raw

func Raw(w http.ResponseWriter, status int, data any, headers map[string]string)

func Unauthorized

func Unauthorized(w http.ResponseWriter, message string)

Types

type Response

type Response struct {
	Message string `json:"message,omitempty"` // user friendly message, it contains error message or success message
	Data    any    `json:"data,omitempty"`    // data
	Error   any    `json:"error,omitempty"`   // raw error for debug purpose only
}

type StatusError

type StatusError struct {
	Status  int    `json:"status"`
	Message string `json:"message"`
	RawErr  error  `json:"error,omitempty"`
}

func NewStatusError

func NewStatusError(status int, err error) *StatusError

func NewStatusErrorMessage

func NewStatusErrorMessage(status int, message string) *StatusError

func NewStatusErrorf

func NewStatusErrorf(status int, format string, args ...any) *StatusError

NewStatusErrorf acts like fmt.Errorf but returns a StatusError. Usage:

if err:=someprocess(username); err!=nil {
  return NewStatusErrorf(http.StatusNotFound, "user %s not found: %w", username, err)
}

func (StatusError) Error

func (e StatusError) Error() string