README
¶
WORK IN PROGRESS!
Echo

A fast and unfancy micro web framework for Go.
package main
import (
"github.com/labstack/echo"
// "github.com/labstack/echo/engine/fasthttp"
"github.com/labstack/echo/engine/standard"
mw "github.com/labstack/echo/middleware"
)
func main() {
e := echo.New()
e.Use(mw.Log())
e.Get("/", func(c echo.Context) error {
return c.String(200, "Hello, World!")
})
e.Get("/v2", func(c echo.Context) error {
return c.String(200, "Echo v2")
})
// FastHTTP
// e.Run(fasthttp.New(":4444"))
// Standard
e.Run(standard.New(":4444"))
}
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
Contribute
Use issues for everything
- Report problems
- Discuss before sending a pull request
- Suggest new features/recipes
- Improve/fix documentation
Credits
- Vishal Rana - Author
- Nitin Rana - Consultant
- Contributors
Documentation
¶
Index ¶
- Constants
- Variables
- type Binder
- type Context
- type Echo
- func (e *Echo) Any(path string, handler interface{})
- func (e *Echo) AutoIndex(on bool)
- func (e *Echo) Connect(path string, handler interface{})
- func (e *Echo) Debug() bool
- func (e *Echo) DefaultHTTPErrorHandler(err error, c Context)
- func (e *Echo) Delete(path string, handler interface{})
- func (e *Echo) Favicon(file string)
- func (e *Echo) Get(path string, handler interface{})
- func (e *Echo) Group(prefix string, m ...MiddlewareFunc) *Group
- func (e *Echo) HTTP2(on bool)
- func (e *Echo) Head(path string, handler interface{})
- func (e *Echo) Hook(h engine.HandlerFunc)
- func (e *Echo) Index(file string)
- func (e *Echo) Logger() logger.Logger
- func (e *Echo) Match(methods []string, path string, handler interface{})
- func (e *Echo) Options(path string, handler interface{})
- func (e *Echo) Patch(path string, handler interface{})
- func (e *Echo) Post(path string, handler interface{})
- func (e *Echo) Put(path string, handler interface{})
- func (e *Echo) Router() *Router
- func (e *Echo) Routes() []Route
- func (e *Echo) Run(eng engine.Engine)
- func (e *Echo) ServeDir(path, dir string)
- func (e *Echo) ServeFile(path, file string)
- func (e *Echo) ServeHTTP(req engine.Request, res engine.Response)
- func (e *Echo) SetBinder(b Binder)
- func (e *Echo) SetDebug(on bool)
- func (e *Echo) SetHTTPErrorHandler(h HTTPErrorHandler)
- func (e *Echo) SetLogger(l logger.Logger)
- func (e *Echo) SetRenderer(r Renderer)
- func (e *Echo) Static(path, dir string)
- func (e *Echo) Trace(path string, handler interface{})
- func (e *Echo) URI(h HandlerFunc, params ...interface{}) string
- func (e *Echo) URL(h HandlerFunc, params ...interface{}) string
- func (e *Echo) Use(middleware ...interface{})
- type Group
- func (g *Group) Connect(path string, h HandlerFunc)
- func (g *Group) Delete(path string, h HandlerFunc)
- func (g *Group) Get(path string, h HandlerFunc)
- func (g *Group) Group(prefix string, m ...MiddlewareFunc) *Group
- func (g *Group) Head(path string, h HandlerFunc)
- func (g *Group) Options(path string, h HandlerFunc)
- func (g *Group) Patch(path string, h HandlerFunc)
- func (g *Group) Post(path string, h HandlerFunc)
- func (g *Group) Put(path string, h HandlerFunc)
- 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 HandlerFunc)
- func (g *Group) Use(m ...MiddlewareFunc)
- type HTTPError
- type HTTPErrorHandler
- type Handler
- type HandlerFunc
- type Middleware
- type MiddlewareFunc
- type Renderer
- 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 ¶
var ( UnsupportedMediaType = NewHTTPError(http.StatusUnsupportedMediaType) RendererNotRegistered = errors.New("renderer not registered") InvalidRedirectCode = errors.New("invalid redirect status code") )
Functions ¶
This section is empty.
Types ¶
type Context ¶
type Context interface { netContext.Context Request() engine.Request Response() engine.Response Socket() *websocket.Conn Path() string P(int) string Param(string) string Query(string) string Form(string) string Set(string, interface{}) Get(string) interface{} Bind(interface{}) error Render(int, string, interface{}) error HTML(int, string) error String(int, string) error JSON(int, interface{}) error JSONIndent(int, interface{}, string, string) error JSONP(int, string, interface{}) error XML(int, interface{}) error XMLIndent(int, interface{}, string, string) error File(string, string, bool) error NoContent(int) error Redirect(int, string) error Error(err error) Logger() logger.Logger Object() *context }
Context represents context for the current request. It holds request and response objects, path parameters, data and registered handler.
type Echo ¶
type Echo struct {
// contains filtered or unexported fields
}
func (*Echo) AutoIndex ¶
AutoIndex enable/disable automatically creating an index page for the directory.
func (*Echo) DefaultHTTPErrorHandler ¶
DefaultHTTPErrorHandler invokes the default HTTP error handler.
func (*Echo) Group ¶
func (e *Echo) Group(prefix string, m ...MiddlewareFunc) *Group
Group creates a new sub router with prefix. It inherits all properties from the parent. Passing middleware overrides parent middleware.
func (*Echo) Hook ¶
func (e *Echo) Hook(h engine.HandlerFunc)
Hook registers a callback which is invoked from `Echo#ServerHTTP` as the first statement. Hook is useful if you want to modify response/response objects even before it hits the router or any middleware.
func (*Echo) SetHTTPErrorHandler ¶
func (e *Echo) SetHTTPErrorHandler(h HTTPErrorHandler)
SetHTTPErrorHandler registers a custom Echo.HTTPErrorHandler.
func (*Echo) SetRenderer ¶
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) URI ¶
func (e *Echo) URI(h HandlerFunc, params ...interface{}) string
URI generates a URI from handler.
func (*Echo) URL ¶
func (e *Echo) URL(h HandlerFunc, params ...interface{}) string
URL is an alias for `URI` function.
type Group ¶
type Group struct {
// contains filtered or unexported fields
}
func (*Group) Connect ¶
func (g *Group) Connect(path string, h HandlerFunc)
func (*Group) Delete ¶
func (g *Group) Delete(path string, h HandlerFunc)
func (*Group) Get ¶
func (g *Group) Get(path string, h HandlerFunc)
func (*Group) Head ¶
func (g *Group) Head(path string, h HandlerFunc)
func (*Group) Options ¶
func (g *Group) Options(path string, h HandlerFunc)
func (*Group) Patch ¶
func (g *Group) Patch(path string, h HandlerFunc)
func (*Group) Post ¶
func (g *Group) Post(path string, h HandlerFunc)
func (*Group) Put ¶
func (g *Group) Put(path string, h HandlerFunc)
func (*Group) Trace ¶
func (g *Group) Trace(path string, h HandlerFunc)
func (*Group) Use ¶
func (g *Group) Use(m ...MiddlewareFunc)
type HTTPError ¶
type HTTPError struct {
// contains filtered or unexported fields
}
func NewHTTPError ¶
type HTTPErrorHandler ¶
HTTPErrorHandler is a centralized HTTP error handler.
type HandlerFunc ¶
func (HandlerFunc) Handle ¶
func (f HandlerFunc) Handle(c Context) error
type Middleware ¶
type Middleware interface {
Process(HandlerFunc) HandlerFunc
}
type MiddlewareFunc ¶
type MiddlewareFunc func(HandlerFunc) HandlerFunc
func (MiddlewareFunc) Process ¶
func (f MiddlewareFunc) Process(h HandlerFunc) HandlerFunc