mirror of
https://github.com/labstack/echo.git
synced 2024-12-20 19:52:47 +02:00
6d9e043284
This reintroduces support for Go modules, as v4. CloseNotifier() is removed as it has been obsoleted, see https://golang.org/doc/go1.11#net/http It was already NOT working (not sending signals) as of 1.11 the functionality was gone, we merely deleted the functions that exposed it. If anyone still relies on it they should migrate to using `c.Request().Context().Done()` instead. Closes #1268, #1255
115 lines
3.6 KiB
Markdown
115 lines
3.6 KiB
Markdown
<a href="https://echo.labstack.com"><img height="80" src="https://cdn.labstack.com/images/echo-logo.svg"></a>
|
|
|
|
[](https://sourcegraph.com/github.com/labstack/echo?badge)
|
|
[](http://godoc.org/github.com/labstack/echo)
|
|
[](https://goreportcard.com/report/github.com/labstack/echo)
|
|
[](https://travis-ci.org/labstack/echo)
|
|
[](https://codecov.io/gh/labstack/echo)
|
|
[](https://gitter.im/labstack/echo)
|
|
[](https://forum.labstack.com)
|
|
[](https://twitter.com/labstack)
|
|
[](https://raw.githubusercontent.com/labstack/echo/master/LICENSE)
|
|
|
|
## Supported Go versions
|
|
|
|
As of version 4.0.0, Echo is available as a [Go module](https://github.com/golang/go/wiki/Modules).
|
|
Therefore a Go version capable of understanding /vN suffixed imports is required:
|
|
|
|
- 1.9.7+
|
|
- 1.10.3+
|
|
- 1.11+
|
|
|
|
Any of these versions will allow you to import Echo as `github.com/labstack/echo/v4` which is the recommended
|
|
way of using Echo going forward.
|
|
|
|
For older versions, please use the latest v3 tag.
|
|
|
|
## Feature Overview
|
|
|
|
- Optimized HTTP router which smartly prioritize routes
|
|
- Build robust and scalable RESTful APIs
|
|
- Group APIs
|
|
- Extensible middleware framework
|
|
- Define middleware at root, group or route level
|
|
- Data binding for JSON, XML and form payload
|
|
- Handy functions to send variety of HTTP responses
|
|
- Centralized HTTP error handling
|
|
- Template rendering with any template engine
|
|
- Define your format for the logger
|
|
- Highly customizable
|
|
- Automatic TLS via Let’s Encrypt
|
|
- HTTP/2 support
|
|
|
|
## Benchmarks
|
|
|
|
Date: 2018/03/15<br>
|
|
Source: https://github.com/vishr/web-framework-benchmark<br>
|
|
Lower is better!
|
|
|
|
<img src="https://i.imgur.com/I32VdMJ.png">
|
|
|
|
## [Guide](https://echo.labstack.com/guide)
|
|
|
|
### Example
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"github.com/labstack/echo/v4"
|
|
"github.com/labstack/echo/v4/middleware"
|
|
)
|
|
|
|
func main() {
|
|
// Echo instance
|
|
e := echo.New()
|
|
|
|
// Middleware
|
|
e.Use(middleware.Logger())
|
|
e.Use(middleware.Recover())
|
|
|
|
// Routes
|
|
e.GET("/", hello)
|
|
|
|
// Start server
|
|
e.Logger.Fatal(e.Start(":1323"))
|
|
}
|
|
|
|
// Handler
|
|
func hello(c echo.Context) error {
|
|
return c.String(http.StatusOK, "Hello, World!")
|
|
}
|
|
```
|
|
|
|
## Help
|
|
|
|
- [Forum](https://forum.labstack.com)
|
|
- [Chat](https://gitter.im/labstack/echo)
|
|
|
|
## Contribute
|
|
|
|
**Use issues for everything**
|
|
|
|
- For a small change, just send a PR.
|
|
- For bigger changes open an issue for discussion before sending a PR.
|
|
- PR should have:
|
|
- Test case
|
|
- Documentation
|
|
- Example (If it makes sense)
|
|
- You can also contribute by:
|
|
- Reporting issues
|
|
- Suggesting new features or enhancements
|
|
- 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)
|