2018-08-06 12:47:05 -07:00
< a href = "https://echo.labstack.com" > < img height = "80" src = "https://cdn.labstack.com/images/echo-logo.svg" > < / a >
[![Sourcegraph ](https://sourcegraph.com/github.com/labstack/echo/-/badge.svg?style=flat-square )](https://sourcegraph.com/github.com/labstack/echo?badge)
2021-03-20 14:40:23 -07:00
[![GoDoc ](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square )](https://pkg.go.dev/github.com/labstack/echo/v4)
2018-08-06 12:47:05 -07:00
[![Go Report Card ](https://goreportcard.com/badge/github.com/labstack/echo?style=flat-square )](https://goreportcard.com/report/github.com/labstack/echo)
[![Build Status ](http://img.shields.io/travis/labstack/echo.svg?style=flat-square )](https://travis-ci.org/labstack/echo)
2019-01-31 08:06:36 -08:00
[![Codecov ](https://img.shields.io/codecov/c/github/labstack/echo.svg?style=flat-square )](https://codecov.io/gh/labstack/echo)
2018-08-06 12:47:05 -07:00
[![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)
2021-03-20 14:40:23 -07:00
[![Forum ](https://img.shields.io/badge/community-forum-00afd1.svg?style=flat-square )](https://github.com/labstack/echo/discussions)
2018-08-06 12:47:05 -07:00
[![Twitter ](https://img.shields.io/badge/twitter-@labstack-55acee.svg?style=flat-square )](https://twitter.com/labstack)
[![License ](http://img.shields.io/badge/license-mit-blue.svg?style=flat-square )](https://raw.githubusercontent.com/labstack/echo/master/LICENSE)
2019-01-31 08:06:36 -08:00
## 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+
2020-09-04 14:29:13 -07:00
- 1.14+
2019-01-31 08:06:36 -08:00
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.
2018-08-06 12:47:05 -07:00
## 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
2018-11-18 09:55:05 -08:00
## Benchmarks
2018-08-06 12:47:05 -07:00
2021-03-20 14:40:23 -07:00
Date: 2020/11/11< br >
2018-11-18 09:55:05 -08:00
Source: https://github.com/vishr/web-framework-benchmark< br >
Lower is better!
2021-03-20 14:40:23 -07: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
2018-08-06 12:47:05 -07:00
## [Guide](https://echo.labstack.com/guide)
2020-05-23 15:06:21 -07:00
### Installation
2020-09-04 14:29:13 -07:00
```sh
2020-05-23 15:06:21 -07:00
// go get github.com/labstack/echo/{version}
go get github.com/labstack/echo/v4
```
2018-08-06 12:47:05 -07:00
### Example
```go
package main
import (
2019-06-16 14:33:25 -07:00
"github.com/labstack/echo/v4"
"github.com/labstack/echo/v4/middleware"
2022-01-18 11:42:25 -08:00
"net/http"
2018-08-06 12:47:05 -07:00
)
func main() {
2019-06-16 14:33:25 -07:00
// Echo instance
e := echo.New()
2018-08-06 12:47:05 -07:00
2019-06-16 14:33:25 -07:00
// Middleware
e.Use(middleware.Logger())
e.Use(middleware.Recover())
2018-08-06 12:47:05 -07:00
2019-06-16 14:33:25 -07:00
// Routes
e.GET("/", hello)
2018-08-06 12:47:05 -07:00
2019-06-16 14:33:25 -07:00
// Start server
e.Logger.Fatal(e.Start(":1323"))
2018-08-06 12:47:05 -07:00
}
// Handler
func hello(c echo.Context) error {
2019-06-16 14:33:25 -07:00
return c.String(http.StatusOK, "Hello, World!")
2018-08-06 12:47:05 -07:00
}
```
## Help
2021-03-20 14:40:23 -07:00
- [Forum ](https://github.com/labstack/echo/discussions )
2018-08-06 12:47:05 -07:00
- [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
2019-01-31 08:06:36 -08:00
2021-10-16 15:47:22 -07: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)
2018-08-06 12:47:05 -07:00
- [Contributors ](https://github.com/labstack/echo/graphs/contributors )
## License
[MIT ](https://github.com/labstack/echo/blob/master/LICENSE )