mirror of
https://github.com/labstack/echo.git
synced 2024-12-22 20:06:21 +02:00
132 lines
7.6 KiB
Markdown
132 lines
7.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)
|
|
[](https://pkg.go.dev/github.com/labstack/echo/v4)
|
|
[](https://goreportcard.com/report/github.com/labstack/echo)
|
|
[](https://travis-ci.org/labstack/echo)
|
|
[](https://codecov.io/gh/labstack/echo)
|
|
[](https://github.com/labstack/echo/discussions)
|
|
[](https://twitter.com/labstack)
|
|
[](https://raw.githubusercontent.com/labstack/echo/master/LICENSE)
|
|
|
|
## Supported Go versions
|
|
|
|
Echo supports last four major releases. `v5` starts from 1.16 until there is last four major releases after that.
|
|
|
|
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.16+
|
|
|
|
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
|
|
|
|
## [Guide](https://echo.labstack.com/guide)
|
|
|
|
### Installation
|
|
|
|
```sh
|
|
// go get github.com/labstack/echo/{version}
|
|
go get github.com/labstack/echo/v5
|
|
```
|
|
|
|
### Example
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"github.com/labstack/echo/v5"
|
|
"github.com/labstack/echo/v5/middleware"
|
|
"net/http"
|
|
)
|
|
|
|
func main() {
|
|
// Echo instance
|
|
e := echo.New()
|
|
|
|
// Middleware
|
|
e.Use(middleware.Logger())
|
|
e.Use(middleware.Recover())
|
|
|
|
// Routes
|
|
e.GET("/", hello)
|
|
|
|
// Start server
|
|
if err := e.Start(":1323"); err != http.ErrServerClosed {
|
|
log.Fatal(err)
|
|
}
|
|
}
|
|
|
|
// Handler
|
|
func hello(c echo.Context) error {
|
|
return c.String(http.StatusOK, "Hello, World!")
|
|
}
|
|
```
|
|
|
|
# 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´s [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. |
|
|
|
|
Please send a PR to add your own library here.
|
|
|
|
## Help
|
|
|
|
- [Forum](https://github.com/labstack/echo/discussions)
|
|
|
|
## 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)
|
|
- [Roland Lammel](https://github.com/lammel) (Maintainer)
|
|
- [Martti T.](https://github.com/aldas) (Maintainer)
|
|
- [Pablo Andres Fuente](https://github.com/pafuent) (Maintainer)
|
|
- [Contributors](https://github.com/labstack/echo/graphs/contributors)
|
|
|
|
## License
|
|
|
|
[MIT](https://github.com/labstack/echo/blob/master/LICENSE)
|