middleware

Documentation

Index

• Constants
• func BasicAuth(fn BasicValidateFunc) echo.HandlerFunc
• func Gzip() echo.MiddlewareFunc
• func JWTAuth(fn JWTValidateFunc) echo.HandlerFunc
• func Logger() echo.MiddlewareFunc
• func Recover() echo.MiddlewareFunc
• func RedirectToSlash(opts ...RedirectToSlashOptions) echo.HandlerFunc
• func StripTrailingSlash() echo.HandlerFunc
• type BasicValidateFunc
• type JWTValidateFunc
• type RedirectToSlashOptions

Constants

const (
	Basic  = "Basic"
	Bearer = "Bearer"
)

Functions

func BasicAuth

func BasicAuth(fn BasicValidateFunc) echo.HandlerFunc

BasicAuth returns an HTTP basic authentication middleware.

For valid credentials it calls the next handler. For invalid Authorization header it sends "404 - Bad Request" response. For invalid credentials, it sends "401 - Unauthorized" response.

func Gzip

func Gzip() echo.MiddlewareFunc

Gzip returns a middleware which compresses HTTP response using gzip compression scheme.

func JWTAuth

func JWTAuth(fn JWTValidateFunc) echo.HandlerFunc

JWTAuth returns a JWT authentication middleware.

For valid token it sets JWT claims in the context with key `_claims` and calls the next handler. For invalid Authorization header it sends "404 - Bad Request" response. For invalid credentials, it sends "401 - Unauthorized" response.

func Logger

func Logger() echo.MiddlewareFunc

func Recover

func Recover() echo.MiddlewareFunc

Recover returns a middleware which recovers from panics anywhere in the chain and handles the control to the centralized HTTPErrorHandler.

func RedirectToSlash

func RedirectToSlash(opts ...RedirectToSlashOptions) echo.HandlerFunc

RedirectToSlash returns a middleware which redirects requests without trailing slash path to trailing slash path.

func StripTrailingSlash

func StripTrailingSlash() echo.HandlerFunc

StripTrailingSlash returns a middleware which removes trailing slash from request path.

Types

type BasicValidateFunc

type BasicValidateFunc func(string, string) bool

type JWTValidateFunc

type JWTValidateFunc func(string, jwt.SigningMethod) ([]byte, error)

type RedirectToSlashOptions

type RedirectToSlashOptions struct {
	Code int
}