README ¶
Echo
A fast and unfancy micro web framework for Go.
Features
- Fast HTTP router which smartly prioritize routes.
- Extensible middleware, supports:
echo.MiddlewareFunc
func(echo.HandlerFunc) echo.HandlerFunc
echo.HandlerFunc
func(*echo.Context) error
func(http.Handler) http.Handler
http.Handler
http.HandlerFunc
func(http.ResponseWriter, *http.Request)
- Extensible handler, supports:
echo.HandlerFunc
func(*echo.Context) error
http.Handler
http.HandlerFunc
func(http.ResponseWriter, *http.Request)
- Sub-router/Groups
- Handy functions to send variety of HTTP response:
- HTML
- HTML via templates
- String
- JSON
- JSONP
- XML
- File
- NoContent
- Redirect
- Error
- Build-in support for:
- Favicon
- Index file
- Static files
- WebSocket
- Centralized HTTP error handling.
- Customizable HTTP request binding function.
- Customizable HTTP response rendering function, allowing you to use any HTML template engine.
Performance
Based on [vishr/go-http-routing-benchmark] (https://github.com/vishr/go-http-routing-benchmark), June 5, 2015.
Echo: 38662 ns/op, 0 B/op, 0 allocs/op
BenchmarkAce_GithubAll 20000 93675 ns/op 13792 B/op 167 allocs/op
BenchmarkBear_GithubAll 10000 264194 ns/op 79952 B/op 943 allocs/op
BenchmarkBeego_GithubAll 2000 1109160 ns/op 146272 B/op 2092 allocs/op
BenchmarkBone_GithubAll 1000 2063973 ns/op 648016 B/op 8119 allocs/op
BenchmarkDenco_GithubAll 20000 83114 ns/op 20224 B/op 167 allocs/op
BenchmarkEcho_GithubAll 30000 38662 ns/op 0 B/op 0 allocs/op
BenchmarkGin_GithubAll 30000 43467 ns/op 0 B/op 0 allocs/op
BenchmarkGocraftWeb_GithubAll 5000 386829 ns/op 133280 B/op 1889 allocs/op
BenchmarkGoji_GithubAll 3000 561131 ns/op 56113 B/op 334 allocs/op
BenchmarkGoJsonRest_GithubAll 3000 490789 ns/op 135995 B/op 2940 allocs/op
BenchmarkGoRestful_GithubAll 100 15569513 ns/op 797239 B/op 7725 allocs/op
BenchmarkGorillaMux_GithubAll 200 7431130 ns/op 153137 B/op 1791 allocs/op
BenchmarkHttpRouter_GithubAll 30000 51192 ns/op 13792 B/op 167 allocs/op
BenchmarkHttpTreeMux_GithubAll 10000 138164 ns/op 56112 B/op 334 allocs/op
BenchmarkKocha_GithubAll 10000 139625 ns/op 23304 B/op 843 allocs/op
BenchmarkMacaron_GithubAll 2000 709932 ns/op 224960 B/op 2315 allocs/op
BenchmarkMartini_GithubAll 100 10261331 ns/op 237953 B/op 2686 allocs/op
BenchmarkPat_GithubAll 500 3989686 ns/op 1504104 B/op 32222 allocs/op
BenchmarkPossum_GithubAll 5000 259165 ns/op 97441 B/op 812 allocs/op
BenchmarkR2router_GithubAll 10000 240345 ns/op 77328 B/op 1182 allocs/op
BenchmarkRevel_GithubAll 2000 1203336 ns/op 345554 B/op 5918 allocs/op
BenchmarkRivet_GithubAll 10000 247213 ns/op 84272 B/op 1079 allocs/op
BenchmarkTango_GithubAll 5000 379960 ns/op 87081 B/op 2470 allocs/op
BenchmarkTigerTonic_GithubAll 2000 931401 ns/op 241089 B/op 6052 allocs/op
BenchmarkTraffic_GithubAll 200 7292170 ns/op 2664770 B/op 22390 allocs/op
BenchmarkVulcan_GithubAll 5000 271682 ns/op 19894 B/op 609 allocs/op
BenchmarkZeus_GithubAll 2000 748827 ns/op 300688 B/op 2648 allocs/op
Installation
$ go get github.com/labstack/echo
Recipes
Guide
Echo System
Community created packages for Echo
Contribute
Use issues for everything
- Report problems
- Discuss before sending pull request
- Suggest new features
- Improve/fix documentation
Credits
- Vishal Rana - Author
- Nitin Rana - Consultant
- Contributors
Documentation ¶
Index ¶
- Constants
- Variables
- type Binder
- type Context
- func (c *Context) Bind(i interface{}) error
- func (c *Context) Error(err error)
- func (c *Context) File(name, path string, attachment bool) (err error)
- func (c *Context) Form(name string) string
- func (c *Context) Get(key string) interface{}
- func (c *Context) HTML(code int, format string, a ...interface{}) (err error)
- func (c *Context) JSON(code int, i interface{}) (err error)
- func (c *Context) JSONP(code int, callback string, i interface{}) (err error)
- func (c *Context) NoContent(code int) error
- func (c *Context) P(i int) (value string)
- func (c *Context) Param(name string) (value string)
- func (c *Context) Query(name string) string
- func (c *Context) Redirect(code int, url string) error
- func (c *Context) Render(code int, name string, data interface{}) (err error)
- func (c *Context) Request() *http.Request
- func (c *Context) Response() *Response
- func (c *Context) Set(key string, val interface{})
- func (c *Context) Socket() *websocket.Conn
- func (c *Context) String(code int, format string, a ...interface{}) (err error)
- func (c *Context) XML(code int, i interface{}) (err error)
- type Echo
- func (e *Echo) Any(path string, h Handler)
- func (e *Echo) Connect(path string, h Handler)
- func (e *Echo) Debug() bool
- func (e *Echo) DefaultHTTPErrorHandler(err error, c *Context)
- func (e *Echo) Delete(path string, h Handler)
- func (e *Echo) DisableColoredLog()
- func (e *Echo) Favicon(file string)
- func (e *Echo) Get(path string, h Handler)
- func (e *Echo) Group(prefix string, m ...Middleware) *Group
- func (e *Echo) HTTP2()
- func (e *Echo) Head(path string, h Handler)
- func (e *Echo) Index(file string)
- func (e *Echo) Match(methods []string, path string, h Handler)
- func (e *Echo) Options(path string, h Handler)
- func (e *Echo) Patch(path string, h Handler)
- func (e *Echo) Post(path string, h Handler)
- func (e *Echo) Put(path string, h Handler)
- func (e *Echo) Router() *Router
- func (e *Echo) Routes() []Route
- func (e *Echo) Run(addr string)
- func (e *Echo) RunServer(s *http.Server)
- func (e *Echo) RunTLS(addr, certFile, keyFile string)
- func (e *Echo) RunTLSServer(s *http.Server, certFile, keyFile string)
- func (e *Echo) ServeDir(path, dir string)
- func (e *Echo) ServeFile(path, file string)
- func (e *Echo) ServeHTTP(w http.ResponseWriter, r *http.Request)
- func (e *Echo) Server(addr string) *http.Server
- func (e *Echo) SetBinder(b Binder)
- func (e *Echo) SetDebug(on bool)
- func (e *Echo) SetHTTPErrorHandler(h HTTPErrorHandler)
- func (e *Echo) SetRenderer(r Renderer)
- func (e *Echo) Static(path, dir string)
- func (e *Echo) StripTrailingSlash()
- func (e *Echo) Trace(path string, h Handler)
- func (e *Echo) URI(h Handler, params ...interface{}) string
- func (e *Echo) URL(h Handler, params ...interface{}) string
- func (e *Echo) Use(m ...Middleware)
- func (e *Echo) WebSocket(path string, h HandlerFunc)
- type Group
- func (g *Group) Connect(path string, h Handler)
- func (g *Group) Delete(path string, h Handler)
- func (g *Group) Get(path string, h Handler)
- func (g *Group) Group(prefix string, m ...Middleware) *Group
- func (g *Group) Head(path string, h Handler)
- func (g *Group) Options(path string, h Handler)
- func (g *Group) Patch(path string, h Handler)
- func (g *Group) Post(path string, h Handler)
- func (g *Group) Put(path string, h Handler)
- func (g *Group) ServeDir(path, root string)
- func (g *Group) ServeFile(path, file string)
- func (g *Group) Static(path, root string)
- func (g *Group) Trace(path string, h Handler)
- func (g *Group) Use(m ...Middleware)
- func (g *Group) WebSocket(path string, h HandlerFunc)
- type HTTPError
- type HTTPErrorHandler
- type Handler
- type HandlerFunc
- type Middleware
- type MiddlewareFunc
- type Renderer
- type Response
- func (r *Response) CloseNotify() <-chan bool
- func (r *Response) Committed() bool
- func (r *Response) Flush()
- func (r *Response) Header() http.Header
- func (r *Response) Hijack() (net.Conn, *bufio.ReadWriter, error)
- func (r *Response) SetWriter(w http.ResponseWriter)
- func (r *Response) Size() int64
- func (r *Response) Status() int
- func (r *Response) Write(b []byte) (n int, err error)
- func (r *Response) WriteHeader(code int)
- func (r *Response) Writer() http.ResponseWriter
- type Route
- type Router
- type Validator
Constants ¶
const ( // CONNECT HTTP method CONNECT = "CONNECT" // DELETE HTTP method DELETE = "DELETE" // GET HTTP method GET = "GET" // HEAD HTTP method HEAD = "HEAD" // OPTIONS HTTP method OPTIONS = "OPTIONS" // PATCH HTTP method PATCH = "PATCH" // POST HTTP method POST = "POST" // PUT HTTP method PUT = "PUT" // TRACE HTTP method TRACE = "TRACE" ApplicationJSON = "application/json" ApplicationJSONCharsetUTF8 = ApplicationJSON + "; " + CharsetUTF8 ApplicationJavaScript = "application/javascript" ApplicationJavaScriptCharsetUTF8 = ApplicationJavaScript + "; " + CharsetUTF8 ApplicationXML = "application/xml" ApplicationXMLCharsetUTF8 = ApplicationXML + "; " + CharsetUTF8 ApplicationForm = "application/x-www-form-urlencoded" ApplicationProtobuf = "application/protobuf" ApplicationMsgpack = "application/msgpack" TextHTML = "text/html" TextHTMLCharsetUTF8 = TextHTML + "; " + CharsetUTF8 TextPlain = "text/plain" TextPlainCharsetUTF8 = TextPlain + "; " + CharsetUTF8 MultipartForm = "multipart/form-data" CharsetUTF8 = "charset=utf-8" AcceptEncoding = "Accept-Encoding" Authorization = "Authorization" ContentDisposition = "Content-Disposition" ContentEncoding = "Content-Encoding" ContentLength = "Content-Length" ContentType = "Content-Type" Location = "Location" Upgrade = "Upgrade" Vary = "Vary" WWWAuthenticate = "WWW-Authenticate" XForwardedFor = "X-Forwarded-For" XRealIP = "X-Real-IP" WebSocket = "websocket" )
Variables ¶
Functions ¶
This section is empty.
Types ¶
type Context ¶
type Context struct {
// contains filtered or unexported fields
}
Context represents context for the current request. It holds request and response objects, path parameters, data and registered handler.
func NewContext ¶ added in v0.0.13
NewContext creates a Context object.
func (*Context) Bind ¶
Bind binds the request body into specified type `i`. The default binder does it based on Content-Type header.
func (*Context) Error ¶ added in v0.0.10
Error invokes the registered HTTP error handler. Generally used by middleware.
func (*Context) File ¶ added in v1.2.0
File sends a response with the content of the file. If `attachment` is set to true, the client is prompted to save the file with provided `name`, name can be empty, in that case name of the file is used.
func (*Context) HTML ¶ added in v0.0.5
HTML formats according to a format specifier and sends HTML response with status code.
func (*Context) JSONP ¶ added in v1.2.0
JSONP sends a JSONP response with status code. It uses `callback` to construct the JSONP payload.
func (*Context) NoContent ¶ added in v0.0.10
NoContent sends a response with no body and a status code.
func (*Context) Render ¶ added in v0.0.5
Render renders a template with data and sends a text/html response with status code. Templates can be registered using `Echo.SetRenderer()`.
type Echo ¶
type Echo struct {
// contains filtered or unexported fields
}
func (*Echo) DefaultHTTPErrorHandler ¶ added in v1.0.0
DefaultHTTPErrorHandler invokes the default HTTP error handler.
func (*Echo) DisableColoredLog ¶ added in v1.2.0
func (e *Echo) DisableColoredLog()
DisableColoredLog disables colored log.
func (*Echo) Group ¶ added in v0.0.4
func (e *Echo) Group(prefix string, m ...Middleware) *Group
Group creates a new sub router with prefix. It inherits all properties from the parent. Passing middleware overrides parent middleware.
func (*Echo) Match ¶ added in v1.2.0
Match adds a route > handler to the router for multiple HTTP methods provided.
func (*Echo) RunTLSServer ¶ added in v0.0.5
RunTLSServer runs a custom server with TLS configuration.
func (*Echo) ServeHTTP ¶
func (e *Echo) ServeHTTP(w http.ResponseWriter, r *http.Request)
ServeHTTP implements `http.Handler` interface, which serves HTTP requests.
func (*Echo) SetBinder ¶ added in v0.0.14
SetBinder registers a custom binder. It's invoked by Context.Bind().
func (*Echo) SetHTTPErrorHandler ¶ added in v0.0.14
func (e *Echo) SetHTTPErrorHandler(h HTTPErrorHandler)
SetHTTPErrorHandler registers a custom Echo.HTTPErrorHandler.
func (*Echo) SetRenderer ¶ added in v0.0.14
SetRenderer registers an HTML template renderer. It's invoked by Context.Render().
func (*Echo) Static ¶
Static serves static files from a directory. It's an alias for `Echo.ServeDir`
func (*Echo) StripTrailingSlash ¶ added in v1.2.0
func (e *Echo) StripTrailingSlash()
StripTrailingSlash enables removing trailing slash from the request path.
func (*Echo) WebSocket ¶ added in v0.0.14
func (e *Echo) WebSocket(path string, h HandlerFunc)
WebSocket adds a WebSocket route > handler to the router.
type Group ¶ added in v0.0.16
type Group struct {
// contains filtered or unexported fields
}
func (*Group) Use ¶ added in v0.0.16
func (g *Group) Use(m ...Middleware)
func (*Group) WebSocket ¶ added in v0.0.16
func (g *Group) WebSocket(path string, h HandlerFunc)
type HTTPError ¶ added in v0.0.12
type HTTPError struct {
// contains filtered or unexported fields
}
func NewHTTPError ¶ added in v0.0.14
type HTTPErrorHandler ¶ added in v0.0.10
HTTPErrorHandler is a centralized HTTP error handler.
type HandlerFunc ¶
type Middleware ¶
type Middleware interface{}
type MiddlewareFunc ¶
type MiddlewareFunc func(HandlerFunc) HandlerFunc
type Response ¶ added in v0.0.13
type Response struct {
// contains filtered or unexported fields
}
func NewResponse ¶ added in v0.0.14
func NewResponse(w http.ResponseWriter) *Response
func (*Response) CloseNotify ¶ added in v0.0.13
CloseNotify wraps response writer's CloseNotify function.
func (*Response) Flush ¶ added in v0.0.13
func (r *Response) Flush()
Flush wraps response writer's Flush function.
func (*Response) SetWriter ¶ added in v0.0.15
func (r *Response) SetWriter(w http.ResponseWriter)
func (*Response) WriteHeader ¶ added in v0.0.13
func (*Response) Writer ¶ added in v0.0.13
func (r *Response) Writer() http.ResponseWriter
type Router ¶ added in v0.0.16
type Router struct {
// contains filtered or unexported fields
}
func (*Router) Add ¶ added in v0.0.16
func (r *Router) Add(method, path string, h HandlerFunc, e *Echo)