mirror of
https://github.com/labstack/echo.git
synced 2024-11-28 08:38:39 +02:00
106 lines
3.0 KiB
Markdown
106 lines
3.0 KiB
Markdown
# *NOTICE*
|
|
|
|
- Master branch, website and godoc now points to Echo v2.
|
|
- 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
|
|
- Docs: https://github.com/labstack/echo/tree/v1.3/website/content
|
|
|
|
# [Echo](http://labstack.com/echo) [](http://godoc.org/github.com/labstack/echo) [](https://raw.githubusercontent.com/labstack/echo/master/LICENSE) [](https://travis-ci.org/labstack/echo) [](https://coveralls.io/r/labstack/echo) [](https://gitter.im/labstack/echo)
|
|
|
|
**A fast and unfancy micro web framework for Go.**
|
|
|
|
## Features
|
|
|
|
- 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.
|
|
|
|
|
|
|
|
## Getting Started
|
|
|
|
### Installation
|
|
|
|
```sh
|
|
$ go get github.com/labstack/echo
|
|
```
|
|
|
|
### 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](https://labstack.com/echo/recipes/hello-world)
|
|
- Head over to [guide](https://labstack.com/echo/guide/installation)
|
|
|
|
## Contribute
|
|
|
|
**Use issues for everything**
|
|
|
|
- Report issues
|
|
- Discuss before sending pull request
|
|
- Suggest new features
|
|
- 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)
|
|
|
|
## License
|
|
|
|
[MIT](https://github.com/labstack/echo/blob/master/LICENSE)
|