Files
echo/README.md
T

96 lines
3.1 KiB
Markdown
Raw Normal View History

2018-01-25 18:26:21 +01:00
<a href="https://echo.labstack.com"><img height="80" src="https://cdn.labstack.com/images/echo-logo.svg"></a>
2017-06-07 11:10:09 -07:00
2017-06-18 22:35:02 -07:00
[![Sourcegraph](https://sourcegraph.com/github.com/labstack/echo/-/badge.svg?style=flat-square)](https://sourcegraph.com/github.com/labstack/echo?badge)
[![GoDoc](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](http://godoc.org/github.com/labstack/echo)
[![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)
[![Codecov](https://img.shields.io/codecov/c/github/labstack/echo.svg?style=flat-square)](https://codecov.io/gh/labstack/echo) [![Forum](https://img.shields.io/badge/community-forum-00afd1.svg?style=flat-square)](https://forum.labstack.com)
[![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)
2015-06-30 12:10:35 -07:00
2016-06-07 20:24:24 -07:00
## Feature Overview
2015-04-18 16:47:48 -07:00
2016-09-06 19:41:05 -07:00
- 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
2016-11-12 17:26:15 -08:00
- Automatic TLS via Let’s Encrypt
2016-11-25 13:03:03 -08:00
- HTTP/2 support
2015-03-12 14:51:39 -07:00
2015-08-28 10:37:14 -07:00
## Performance
2015-04-18 16:47:48 -07:00
2018-02-04 15:32:34 -08:00
<img src="https://api.labstack.com/chart/bar?values=20015,39584,7282,11276&labels=Static,GitHub%20API,Parse%20API,Google%20Plus%20API&x_title=Route&y_title=Time%20(ns/op)&colors=c&dpi=100">
2015-06-22 14:25:39 -07:00
2018-01-29 20:02:11 -08:00
## [Guide](https://echo.labstack.com/guide)
2016-03-29 13:53:40 -07:00
2018-01-29 20:38:18 -08:00
### Example
2018-01-29 23:00:48 -05:00
2018-01-29 20:02:11 -08:00
```go
2018-01-29 23:00:48 -05:00
package main
import (
"net/http"
"github.com/labstack/echo"
"github.com/labstack/echo/middleware"
)
func main() {
// Echo instance
e := echo.New()
2018-01-29 20:02:11 -08:00
2018-01-29 23:00:48 -05:00
// Middleware
e.Use(middleware.Logger())
e.Use(middleware.Recover())
2018-01-29 20:02:11 -08:00
2018-01-29 23:00:48 -05:00
// Routes
e.GET("/", hello)
2018-01-29 20:02:11 -08:00
2018-01-29 23:00:48 -05:00
// Start server
e.Logger.Fatal(e.Start(":1323"))
}
// Handler
func hello(c echo.Context) error {
return c.String(http.StatusOK, "Hello, World!")
}
```
2016-04-02 19:32:52 -07:00
## Support Us
2016-03-29 13:53:40 -07:00
- :star: the project
2016-09-06 22:09:51 -07:00
- [Donate](https://echo.labstack.com/support-echo)
2016-04-02 14:19:39 -07:00
- :earth_americas: spread the word
2016-03-29 13:53:40 -07:00
- [Contribute](#contribute) to the project
2015-04-25 16:10:28 -07:00
## Contribute
**Use issues for everything**
2015-04-26 22:41:41 -07:00
- 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
2017-01-10 08:45:44 -08:00
- Example (If it makes sense)
- You can also contribute by:
- Reporting issues
- Suggesting new features or enhancements
- Improve/fix documentation
2015-04-25 16:10:28 -07:00
## Credits
- [Vishal Rana](https://github.com/vishr) - Author
- [Nitin Rana](https://github.com/nr17) - Consultant
- [Contributors](https://github.com/labstack/echo/graphs/contributors)
2016-03-10 22:22:42 -08:00
## License
[MIT](https://github.com/labstack/echo/blob/master/LICENSE)