2020-11-25 20:36:07 +01:00
< 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)
2021-04-07 10:58:21 +02:00
[](https://pkg.go.dev/github.com/labstack/echo/v4)
2020-11-25 20:36:07 +01:00
[](https://goreportcard.com/report/github.com/labstack/echo)
[](https://travis-ci.org/labstack/echo)
[](https://codecov.io/gh/labstack/echo)
2021-04-07 10:58:21 +02:00
[](https://github.com/labstack/echo/discussions)
2020-11-25 20:36:07 +01:00
[](https://twitter.com/labstack)
[](https://raw.githubusercontent.com/labstack/echo/master/LICENSE)
## Supported Go versions
2022-11-02 17:49:03 +01:00
Latest version of Echo supports last four Go major [releases ](https://go.dev/doc/devel/release ) and might work with older versions.
2020-11-25 20:36:07 +01:00
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:
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’
- HTTP/2 support
## Benchmarks
2021-04-07 10:58:21 +02:00
Date: 2020/11/11< br >
2020-11-25 20:36:07 +01:00
Source: https://github.com/vishr/web-framework-benchmark< br >
Lower is better!
2021-04-07 10:58:21 +02:00
< img src = "https://i.imgur.com/qwPNQbl.png" >
< img src = "https://i.imgur.com/s8yKQjx.png" >
The benchmarks above were run on an Intel(R) Core(TM) i7-6820HQ CPU @ 2.70GHz
2020-11-25 20:36:07 +01:00
## [Guide](https://echo.labstack.com/guide)
### Installation
```sh
// go get github.com/labstack/echo/{version}
go get github.com/labstack/echo/v4
```
### Example
```go
package main
import (
"github.com/labstack/echo/v4"
"github.com/labstack/echo/v4/middleware"
2022-11-02 17:49:03 +01:00
"net/http"
2020-11-25 20:36:07 +01:00
)
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!")
}
```
2022-11-02 17:49:03 +01:00
# Third-party middlewares
| Repository | Description |
|------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [github.com/labstack/echo-contrib ](https://github.com/labstack/echo-contrib ) | (by Echo team) [casbin ](https://github.com/casbin/casbin ), [gorilla/sessions ](https://github.com/gorilla/sessions ), [jaegertracing ](github.com/uber/jaeger-client-go ), [prometheus ](https://github.com/prometheus/client_golang/ ), [pprof ](https://pkg.go.dev/net/http/pprof ), [zipkin ](https://github.com/openzipkin/zipkin-go ) middlewares |
| [deepmap/oapi-codegen ](https://github.com/deepmap/oapi-codegen ) | Automatically generate RESTful API documentation with [OpenAPI ](https://swagger.io/specification/ ) Client and Server Code Generator |
| [github.com/swaggo/echo-swagger ](https://github.com/swaggo/echo-swagger ) | Automatically generate RESTful API documentation with [Swagger ](https://swagger.io/ ) 2.0. |
| [github.com/ziflex/lecho ](https://github.com/ziflex/lecho ) | [Zerolog ](https://github.com/rs/zerolog ) logging library wrapper for Echo logger interface. |
| [github.com/brpaz/echozap ](https://github.com/brpaz/echozap ) | Uber´ Zap ](https://github.com/uber-go/zap ) logging library wrapper for Echo logger interface. |
| [github.com/darkweak/souin/plugins/echo ](https://github.com/darkweak/souin/tree/master/plugins/echo ) | HTTP cache system based on [Souin ](https://github.com/darkweak/souin ) to automatically get your endpoints cached. It supports some distributed and non-distributed storage systems depending your needs. |
| [github.com/mikestefanello/pagoda ](https://github.com/mikestefanello/pagoda ) | Rapid, easy full-stack web development starter kit built with Echo. |
| [github.com/go-woo/protoc-gen-echo ](https://github.com/go-woo/protoc-gen-echo ) | ProtoBuf generate Echo server side code |
Please send a PR to add your own library here.
2020-11-25 20:36:07 +01:00
## Help
2021-04-07 10:58:21 +02:00
- [Forum ](https://github.com/labstack/echo/discussions )
2020-11-25 20:36:07 +01:00
## 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
2022-11-02 17:49:03 +01:00
- [Vishal Rana ](https://github.com/vishr ) (Author)
- [Nitin Rana ](https://github.com/nr17 ) (Consultant)
- [Roland Lammel ](https://github.com/lammel ) (Maintainer)
- [Martti T. ](https://github.com/aldas ) (Maintainer)
- [Pablo Andres Fuente ](https://github.com/pafuent ) (Maintainer)
2020-11-25 20:36:07 +01:00
- [Contributors ](https://github.com/labstack/echo/graphs/contributors )
## License
[MIT ](https://github.com/labstack/echo/blob/master/LICENSE )
