handlers

Documentation

Index

• func HealthCheckHandler(version, buildTime, commit string) http.HandlerFunc
• type AppError
  • func RenderContent(ctx context.Context, v interface{}, w http.ResponseWriter, status int) *AppError
  • func ValidationError(message string, validationErrors interface{}) *AppError
  • func WrapError(err error, msg string, passedCode int) *AppError
  • func WrapValidationError(err error) *AppError
  • func (e AppError) Error() string
  • func (e AppError) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type AppHandler
  • func (fn AppHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type HealthCheckResponse
  • func (hcr HealthCheckResponse) RenderJSON(ctx context.Context, w http.ResponseWriter) error

Functions

func HealthCheckHandler

func HealthCheckHandler(version, buildTime, commit string) http.HandlerFunc

HealthCheckHandler - function which generates a health check http.HandlerFunc

Types

type AppError

type AppError struct {
	Cause   error       `json:"-"`
	Message string      `json:"message"`
	Code    int         `json:"code"`
	Data    interface{} `json:"data,omitempty"`
}

AppError is error type for json HTTP responses

func RenderContent

func RenderContent(ctx context.Context, v interface{}, w http.ResponseWriter, status int) *AppError

RenderContent based on the header

func ValidationError

func ValidationError(message string, validationErrors interface{}) *AppError

ValidationError creates an error to communicate a bad request was formed

func WrapError

func WrapError(err error, msg string, passedCode int) *AppError

WrapError with an additional message as an AppError

func WrapValidationError

func WrapValidationError(err error) *AppError

WrapValidationError from govalidator

func (AppError) Error

func (e AppError) Error() string

Error makes app error an error

func (AppError) ServeHTTP

func (e AppError) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP responds according to the passed AppError

type AppHandler

type AppHandler func(http.ResponseWriter, *http.Request) *AppError

AppHandler is an http.Handler with JSON requests / reponses

func (AppHandler) ServeHTTP

func (fn AppHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP responds via the passed handler and handles returned errors

type HealthCheckResponse

type HealthCheckResponse struct {
	BuildTime string `json:"build_time"`
	Commit    string `json:"commit"`
	Version   string `json:"version"`
}

HealthCheckResponse - response structure for healthchecks

func (HealthCheckResponse) RenderJSON

func (hcr HealthCheckResponse) RenderJSON(ctx context.Context, w http.ResponseWriter) error

RenderJSON - helper to render a HealthCheckResponse as Json to an http.ResponseWriter