2015-10-08 22:54:31 +02:00
|
|
|
# [Echo](http://labstack.com/echo) [![GoDoc](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](http://godoc.org/github.com/labstack/echo) [![License](http://img.shields.io/badge/license-mit-blue.svg?style=flat-square)](https://raw.githubusercontent.com/labstack/echo/master/LICENSE) [![Build Status](http://img.shields.io/travis/labstack/echo.svg?style=flat-square)](https://travis-ci.org/labstack/echo) [![Coverage Status](http://img.shields.io/coveralls/labstack/echo.svg?style=flat-square)](https://coveralls.io/r/labstack/echo) [![Join the chat at https://gitter.im/labstack/echo](https://img.shields.io/badge/gitter-join%20chat-brightgreen.svg?style=flat-square)](https://gitter.im/labstack/echo)
|
2015-06-30 21:10:35 +02:00
|
|
|
|
2015-08-28 19:37:14 +02:00
|
|
|
A fast and unfancy micro web framework for Go.
|
2015-03-12 23:51:39 +02:00
|
|
|
|
2015-04-14 02:42:44 +02:00
|
|
|
## Features
|
2015-04-19 01:47:48 +02:00
|
|
|
|
2015-06-18 23:40:48 +02:00
|
|
|
- Fast HTTP router which smartly prioritize routes.
|
2015-06-03 18:20:32 +02:00
|
|
|
- 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)`
|
2015-06-18 23:40:48 +02:00
|
|
|
- Sub-router/Groups
|
2015-07-08 22:51:08 +02:00
|
|
|
- Handy functions to send variety of HTTP response:
|
|
|
|
- HTML
|
|
|
|
- HTML via templates
|
2015-08-28 19:37:14 +02:00
|
|
|
- String
|
2015-07-11 21:20:59 +02:00
|
|
|
- JSON
|
2015-07-25 03:54:42 +02:00
|
|
|
- JSONP
|
2015-07-11 21:20:59 +02:00
|
|
|
- XML
|
2015-08-05 04:45:44 +02:00
|
|
|
- File
|
2015-07-08 22:51:08 +02:00
|
|
|
- NoContent
|
|
|
|
- Redirect
|
|
|
|
- Error
|
2015-06-03 18:20:32 +02:00
|
|
|
- Build-in support for:
|
2015-07-08 22:51:08 +02:00
|
|
|
- Favicon
|
|
|
|
- Index file
|
2015-06-03 18:20:32 +02:00
|
|
|
- Static files
|
|
|
|
- WebSocket
|
2015-06-18 23:40:48 +02:00
|
|
|
- Centralized HTTP error handling.
|
2015-07-08 22:51:08 +02:00
|
|
|
- Customizable HTTP request binding function.
|
|
|
|
- Customizable HTTP response rendering function, allowing you to use any HTML template engine.
|
2015-03-12 23:51:39 +02:00
|
|
|
|
2015-08-28 19:37:14 +02:00
|
|
|
## Performance
|
2015-04-19 01:47:48 +02:00
|
|
|
|
2015-06-06 06:47:33 +02:00
|
|
|
Based on [vishr/go-http-routing-benchmark] (https://github.com/vishr/go-http-routing-benchmark), June 5, 2015.
|
2015-04-19 01:47:48 +02:00
|
|
|
|
2015-04-16 19:18:35 +02:00
|
|
|
##### [GitHub API](http://developer.github.com/v3)
|
2015-04-19 01:47:48 +02:00
|
|
|
|
2015-06-06 06:36:31 +02:00
|
|
|
> Echo: 38662 ns/op, 0 B/op, 0 allocs/op
|
2015-04-16 19:18:35 +02:00
|
|
|
|
2015-06-27 22:03:42 +02:00
|
|
|
![Performance](http://i.imgur.com/hB2qdRS.png)
|
2015-06-22 23:25:39 +02:00
|
|
|
|
2015-04-16 19:18:35 +02:00
|
|
|
```
|
2015-06-06 06:36:31 +02:00
|
|
|
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
|
2015-04-16 19:18:35 +02:00
|
|
|
```
|
|
|
|
|
2015-04-14 02:42:44 +02:00
|
|
|
## Installation
|
2015-04-19 01:47:48 +02:00
|
|
|
|
2015-04-26 01:10:28 +02:00
|
|
|
```sh
|
|
|
|
$ go get github.com/labstack/echo
|
|
|
|
```
|
2015-03-29 01:44:28 +02:00
|
|
|
|
2015-10-08 22:54:31 +02:00
|
|
|
## [Recipes](http://labstack.com/echo/recipes/hello-world)
|
2015-05-18 22:38:35 +02:00
|
|
|
|
2015-10-13 03:39:52 +02:00
|
|
|
## [Guide](http://labstack.com/echo/guide/installation)
|
2015-04-26 01:10:28 +02:00
|
|
|
|
2015-07-03 20:50:59 +02:00
|
|
|
## Echo System
|
|
|
|
|
2016-01-30 21:26:45 +02:00
|
|
|
### Who's using Echo?
|
|
|
|
|
|
|
|
- [ShowChampions](https://showchampions.photoserve.co)
|
|
|
|
- [deferpanic](https://deferpanic.com)
|
|
|
|
- [Center for Open Science](https://cos.io)
|
|
|
|
- [SeeSaw Labs](http://www.seesawlabs.com)
|
|
|
|
- [Kyäni](http://www.kyani.net)
|
|
|
|
- [Carrot Creative](http://carrot.is)
|
|
|
|
- [EurekaMetrics](http://eurekametrics.com)
|
|
|
|
- [Coursella](https://www.coursella.com)
|
|
|
|
- [blue Vanilla](https://www.bleuvanille.fr)
|
|
|
|
- [ImPlaces](http://www.implaces.com)
|
|
|
|
- [Gomoku](http://gomoku.thoughtsfromplac.es)
|
|
|
|
- [DrinkIn](https://drinkin.com)
|
|
|
|
- [PodBaby](https://podbaby.me)
|
|
|
|
|
|
|
|
### Community created packages around Echo
|
2015-07-03 20:50:59 +02:00
|
|
|
|
|
|
|
- [echo-logrus](https://github.com/deoxxa/echo-logrus)
|
|
|
|
- [go_middleware](https://github.com/rightscale/go_middleware)
|
|
|
|
- [permissions2](https://github.com/xyproto/permissions2)
|
|
|
|
- [permissionbolt](https://github.com/xyproto/permissionbolt)
|
2015-07-12 00:30:26 +02:00
|
|
|
- [echo-middleware](https://github.com/syntaqx/echo-middleware)
|
2015-11-07 00:53:49 +02:00
|
|
|
- [dpecho](https://github.com/deferpanic/dpecho)
|
2015-11-15 12:09:57 +02:00
|
|
|
- [echosentry](https://github.com/01walid/echosentry)
|
2016-01-30 21:26:45 +02:00
|
|
|
- [go-starter-kit](https://github.com/olebedev/go-starter-kit)
|
|
|
|
|
|
|
|
[Want to get listed?](https://github.com/labstack/echo/issues/295)
|
2015-07-03 20:50:59 +02:00
|
|
|
|
2015-04-26 01:10:28 +02:00
|
|
|
## Contribute
|
|
|
|
|
|
|
|
**Use issues for everything**
|
2015-04-27 07:41:41 +02:00
|
|
|
|
2015-04-26 01:10:28 +02:00
|
|
|
- Report problems
|
2015-11-09 19:43:40 +02:00
|
|
|
- Discuss before sending a pull request
|
|
|
|
- Suggest new features/recipes
|
2015-04-26 01:10:28 +02:00
|
|
|
- Improve/fix documentation
|
|
|
|
|
|
|
|
## Credits
|
|
|
|
- [Vishal Rana](https://github.com/vishr) - Author
|
|
|
|
- [Nitin Rana](https://github.com/nr17) - Consultant
|
|
|
|
- [Contributors](https://github.com/labstack/echo/graphs/contributors)
|