go/echo
go/echo
1
0
Fork 0
mirror of https://github.com/labstack/echo.git synced 2024-12-24 20:14:31 +02:00
Code Issues Releases Activity

Updated README.md

Browse Source 
Signed-off-by: Vishal Rana <vr@labstack.com>
This commit is contained in:
Vishal Rana 2016-03-10 22:22:42 -08:00
parent 91e5f755ad
commit 300d57894d
2 changed files with 76 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

139
README.md
View File

@ -1,8 +1,7 @@
# *NOTICE*
- Master branch, website and godoc now points to Echo v2.
- It is advisable to migrate to v2. (https://labstack.com/echo/migrating)
- It is advisable to migrate to v2. (https://labstack.com/echo/guide/migrating)
- Looking for v1?
- Installation: Use a package manager (https://github.com/Masterminds/glide, it's nice!) to get stable v1 release/commit or use `go get gopkg.in/labstack/echo.v1`.
- Godoc: https://godoc.org/gopkg.in/labstack/echo.v1
@ -12,89 +11,95 @@
**A fast and unfancy micro web framework for Go.**
```go
package main
## Features
import (
"github.com/labstack/echo"
// "github.com/labstack/echo/engine/fasthttp"
"github.com/labstack/echo/engine/standard"
"github.com/labstack/echo/middleware"
)
func main() {
e := echo.New()
e.Use(middleware.Logger())
e.Use(middleware.Recover())
e.Get("/", echo.HandlerFunc(func(c echo.Context) error {
return c.String(200, "Hello, World!")
}))
e.Get("/v2", echo.HandlerFunc(func(c echo.Context) error {
return c.String(200, "Echo v2")
}))
// FastHTTP
// e.Run(fasthttp.New(":1323"))
// Standard
e.Run(standard.New(":1323"))
}
```
- Fast HTTP router which smartly prioritize routes.
- Run with standard HTTP server or FastHTTP server.
- Extensible middleware framework.
- Router groups with nesting.
- Handy functions to send variety of HTTP responses.
- Centralized HTTP error handling.
- Template rendering with any template engine.
## Performance
Based on [vishr/go-http-routing-benchmark] (https://github.com/vishr/go-http-routing-benchmark), June 5, 2015.
##### [GitHub API](http://developer.github.com/v3)
> Echo: 38662 ns/op, 0 B/op, 0 allocs/op
![Performance](http://i.imgur.com/hB2qdRS.png)
## Getting Started
### Installation
```sh
$ go get github.com/labstack/echo
```
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
### Hello, World!
Create `main.go`
```go
package main
import (
"net/http"
"github.com/labstack/echo"
"github.com/labstack/echo/engine/standard"
"github.com/labstack/echo/middleware"
)
// Handler
func hello() echo.HandlerFunc {
return func(c echo.Context) error {
return c.String(http.StatusOK, "Hello, World!\n")
}
}
func main() {
// Echo instance
e := echo.New()
// Middleware
e.Use(middleware.Logger())
e.Use(middleware.Recover())
// Routes
e.Get("/", hello())
// Start server
e.Run(standard.New(":1323"))
}
```
Start server
```sh
$ go run main.go
```
Browse to [http://localhost:1323](http://localhost:1323) and you should see
Hello, World! on the page.
### Next?
- Browse [recipes](/recipes/hello-world)
- Head over to [guide](/guide/installation")
## Contribute
**Use issues for everything**
- Report problems
- Discuss before sending a pull request
- Suggest new features/recipes
- Report issues
- Discuss before sending pull request
- Suggest new features
- Improve/fix documentation
## Support
- [Chat](https://gitter.im/labstack/echo)
## Credits
- [Vishal Rana](https://github.com/vishr) - Author
- [Nitin Rana](https://github.com/nr17) - Consultant
- [Contributors](https://github.com/labstack/echo/graphs/contributors)
## License
[MIT](https://github.com/labstack/echo/blob/master/LICENSE)

4
website/layouts/partials/header.html
View File

@ -11,3 +11,7 @@
</nav>
</div>
</header>
<div style="padding: 4px; text-align: center; background: #ff851b; color: #fff;">
This is Echo v2 website. If you are looking for v1 docs, they can be found <a style=
"color: #fff;" href="https://github.com/labstack/echo/tree/v1/website/content"><b>here</b>.</a>
</div>