web

Documentation

Overview

Package web implements a middleware to handle HTTP errors.

Index

• func ErrorMiddleware(extraRenderers map[string]ErrorRenderer) echo.MiddlewareFunc
• func ProcessError(in error) (statusCode int, err error)
• func RegisterRenderer(contentType string, renderer ErrorRenderer)
• type ErrorRenderer
• type ErrorRendererFunc
  • func (f ErrorRendererFunc) RenderError(c echo.Context, statusCode int, err error) error

Functions

func ErrorMiddleware

func ErrorMiddleware(extraRenderers map[string]ErrorRenderer) echo.MiddlewareFunc

ErrorMiddleware returns an Echo middleware that catches errors in the chain, and renders them using the negotiated renderer. Global renderers can be registered with RegisterRenderer, and extra renderers can be passed to this function.

func ProcessError

func ProcessError(in error) (statusCode int, err error)

ProcessError processes an HTTP error by converting it if appropriate, and determining the HTTP status code to return.

func RegisterRenderer

func RegisterRenderer(contentType string, renderer ErrorRenderer)

RegisterRenderer registers a global error renderer.

Types

type ErrorRenderer

type ErrorRenderer interface {
	RenderError(c echo.Context, statusCode int, err error) error
}

ErrorRenderer is an interface for rendering errors to HTTP responses.

type ErrorRendererFunc

type ErrorRendererFunc func(c echo.Context, statusCode int, err error) error

ErrorRendererFunc is a function signature that implements ErrorRenderer.

func (ErrorRendererFunc) RenderError

func (f ErrorRendererFunc) RenderError(c echo.Context, statusCode int, err error) error

RenderError implements the ErrorRenderer interface.