web

Documentation

Index

• Variables
• func StartServer(e *Engine, bind string) error
• type BasicAuthValidator
• type Context
• type Engine
  • func New(opts Options) *Engine
• type Group
• type HandlerFunc
• type MiddlewareFunc
  • func AddTrailingSlash() MiddlewareFunc
  • func BasicAuth(fn BasicAuthValidator) MiddlewareFunc
  • func RemoveTrailingSlash() MiddlewareFunc
• type Options

Variables

var (
	ErrUnsupportedMediaType        = echo.ErrUnsupportedMediaType
	ErrNotFound                    = echo.ErrNotFound
	ErrUnauthorized                = echo.ErrUnauthorized
	ErrForbidden                   = echo.ErrForbidden
	ErrMethodNotAllowed            = echo.ErrMethodNotAllowed
	ErrStatusRequestEntityTooLarge = echo.ErrStatusRequestEntityTooLarge
	ErrValidatorNotRegistered      = echo.ErrValidatorNotRegistered
	ErrRendererNotRegistered       = echo.ErrRendererNotRegistered
	ErrInvalidRedirectCode         = echo.ErrInvalidRedirectCode
	ErrCookieNotFound              = echo.ErrCookieNotFound
)

Errors

var (
	// NewHTTPError creates a new HTTPError instance.
	NewHTTPError = echo.NewHTTPError
)

Functions

func StartServer

func StartServer(e *Engine, bind string) error

StartServer HTTP with custom address.

Types

type BasicAuthValidator

type BasicAuthValidator = middleware.BasicAuthValidator

BasicAuthValidator defines a function to validate BasicAuth credentials.

type Context

type Context = echo.Context

Context from echo.Context (for shadowing)

type Engine

type Engine = echo.Echo

Engine from echo.Echo (for shadowing)

func New

func New(opts Options) *Engine

New creates an instance of Echo.

type Group

type Group = echo.Group

Group from echo.Group (for shadowing)

type HandlerFunc

type HandlerFunc = echo.HandlerFunc

HandlerFunc from echo.HandlerFunc (for shadowing)

type MiddlewareFunc

type MiddlewareFunc = echo.MiddlewareFunc

MiddlewareFunc from echo.MiddlewareFunc (for shadowing)

func AddTrailingSlash

func AddTrailingSlash() MiddlewareFunc

AddTrailingSlash returns a root level (before router) middleware which adds a trailing slash to the request `URL#Path`.

Usage `Engine#Pre(AddTrailingSlash())`

func BasicAuth

func BasicAuth(fn BasicAuthValidator) MiddlewareFunc

BasicAuth returns an BasicAuth middleware.

For valid credentials it calls the next handler. For missing or invalid credentials, it sends "401 - Unauthorized" response.

func RemoveTrailingSlash

func RemoveTrailingSlash() MiddlewareFunc

RemoveTrailingSlash returns a root level (before router) middleware which removes a trailing slash from the request URI.

Usage `Engine#Pre(RemoveTrailingSlash())`

type Options

type Options struct {
	Logger    echo.Logger
	Error     recoverer
	Debug     bool
	Validator echo.Validator
}

Options contains a parameters for new Echo instance.