1
0
mirror of https://github.com/labstack/echo.git synced 2024-11-24 08:22:21 +02:00
High performance, minimalist Go web framework https://echo.labstack.com/
Go to file
Martti T 7c7531002d
Clean on go1.20 (#2406)
* Fix tests failing on Go 1.20 on Windows. Clean works differently on 1.20. Use path.Clean instead with some workaround related to errors.
2023-02-22 00:00:52 +02:00
_fixture Fix Echo.Serve() will not serve on HTTP port correctly when there is already TLSListener set to Echo instance. (#1785) (#1793) 2021-02-28 19:13:04 +01:00
.github Upgrade deps due to the latest golang.org/x/net vulnerability 2023-02-19 20:26:17 +02:00
middleware Clean on go1.20 (#2406) 2023-02-22 00:00:52 +02:00
.editorconfig updated docs 2016-11-16 21:26:56 -08:00
.gitattributes Updated website and examples 2017-01-17 10:47:16 -08:00
.gitignore adds middleware for rate limiting (#1724) 2021-01-15 17:53:15 -03:00
bind_test.go update tests (#2275) 2022-10-06 11:34:00 +03:00
bind.go Adding support for HEAD method query params binding (#2027) 2022-01-24 10:28:48 +01:00
binder_external_test.go Fluent Binder for Query/Path/Form binding (#1717) (#1736) 2021-01-08 00:43:38 +01:00
binder_test.go Fix #2259 open redirect vulnerability in echo.StaticDirectoryHandler (used by e.Static, e.StaticFs etc) 2022-09-04 22:50:54 +03:00
binder.go Tidy up comments for value binders 2022-03-17 14:14:42 +02:00
CHANGELOG.md Changelog for v4.10.1 2023-02-19 21:12:17 +02:00
codecov.yml Adding Codecov configuration 2020-12-01 05:00:19 +00:00
context_fs_test.go Fix #2259 open redirect vulnerability in echo.StaticDirectoryHandler (used by e.Static, e.StaticFs etc) 2022-09-04 22:50:54 +03:00
context_fs.go Fix #2259 open redirect vulnerability in echo.StaticDirectoryHandler (used by e.Static, e.StaticFs etc) 2022-09-04 22:50:54 +03:00
context_test.go Remove square brackets from ipv6 addresses in XFF (#2182) 2022-11-24 22:17:31 +02:00
context.go Additional configuration options for RequestLogger and Logger middleware (#2341) 2022-11-30 15:47:23 +02:00
echo_fs_test.go Fix #2259 open redirect vulnerability in echo.StaticDirectoryHandler (used by e.Static, e.StaticFs etc) 2022-09-04 22:50:54 +03:00
echo_fs.go Replace relative path determination from proprietary to std 2022-11-23 09:42:40 +02:00
echo_test.go Add echo.OnAddRouteHandler field. As name says - this handler is called when new route is registered. 2022-12-25 22:19:15 +02:00
echo.go Add more http error values (#2277) 2023-02-21 22:32:11 +01:00
go.mod Upgrade deps due to the latest golang.org/x/net vulnerability 2023-02-19 20:26:17 +02:00
go.sum Upgrade deps due to the latest golang.org/x/net vulnerability 2023-02-19 20:26:17 +02:00
group_fs_test.go Fix #2259 open redirect vulnerability in echo.StaticDirectoryHandler (used by e.Static, e.StaticFs etc) 2022-09-04 22:50:54 +03:00
group_fs.go Fix #2259 open redirect vulnerability in echo.StaticDirectoryHandler (used by e.Static, e.StaticFs etc) 2022-09-04 22:50:54 +03:00
group_test.go Replace "io/ioutil" 2022-11-21 15:59:14 +02:00
group.go Add support for registering handlers for 404 routes (#2217) 2022-07-12 21:53:41 +03:00
ip_test.go Remove square brackets from ipv6 addresses in XFF (#2182) 2022-11-24 22:17:31 +02:00
ip.go Remove square brackets from ipv6 addresses in XFF (#2182) 2022-11-24 22:17:31 +02:00
json_test.go Allow for custom JSON encoding implementations (#1880) 2021-07-05 22:33:19 +03:00
json.go Allow for custom JSON encoding implementations (#1880) 2021-07-05 22:33:19 +03:00
LICENSE Create LICENSE 2021-04-17 12:47:48 -07:00
log.go the logging interface add SetHeader method (#1092) 2018-09-28 10:47:23 -07:00
Makefile Add staticcheck to CI flow 2022-11-21 16:26:13 +02:00
README.md Update link to jaegertracing 2023-02-10 14:43:25 +02:00
response_test.go Add the ability to change the status code using Response beforeFuncs 2020-12-06 18:31:15 +03:30
response.go Add the ability to change the status code using Response beforeFuncs 2020-12-06 18:31:15 +03:30
router_test.go Return an empty string for ctx.path if there is no registered path 2023-01-28 18:15:49 +02:00
router.go Return an empty string for ctx.path if there is no registered path 2023-01-28 18:15:49 +02:00

Sourcegraph GoDoc Go Report Card Build Status Codecov Forum Twitter License

Supported Go versions

Latest version of Echo supports last four Go major releases and might work with older versions.

As of version 4.0.0, Echo is available as a Go module. 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’s Encrypt
  • HTTP/2 support

Benchmarks

Date: 2020/11/11
Source: https://github.com/vishr/web-framework-benchmark
Lower is better!

The benchmarks above were run on an Intel(R) Core(TM) i7-6820HQ CPU @ 2.70GHz

Guide

Installation

// go get github.com/labstack/echo/{version}
go get github.com/labstack/echo/v4

Example

package main

import (
  "github.com/labstack/echo/v4"
  "github.com/labstack/echo/v4/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
  e.Logger.Fatal(e.Start(":1323"))
}

// Handler
func hello(c echo.Context) error {
  return c.String(http.StatusOK, "Hello, World!")
}

Official middleware repositories

Following list of middleware is maintained by Echo team.

Repository Description
github.com/labstack/echo-jwt JWT middleware
github.com/labstack/echo-contrib casbin, gorilla/sessions, jaegertracing, prometheus, pprof, zipkin middlewares

Third-party middleware repositories

Be careful when adding 3rd party middleware. Echo teams does not have time or manpower to guarantee safety and quality of middlewares in this list.

Repository Description
deepmap/oapi-codegen Automatically generate RESTful API documentation with OpenAPI Client and Server Code Generator
github.com/swaggo/echo-swagger Automatically generate RESTful API documentation with Swagger 2.0.
github.com/ziflex/lecho Zerolog logging library wrapper for Echo logger interface.
github.com/brpaz/echozap Uber´s Zap logging library wrapper for Echo logger interface.
github.com/darkweak/souin/plugins/echo HTTP cache system based on Souin to automatically get your endpoints cached. It supports some distributed and non-distributed storage systems depending your needs.
github.com/mikestefanello/pagoda Rapid, easy full-stack web development starter kit built with Echo.
github.com/go-woo/protoc-gen-echo ProtoBuf generate Echo server side code

Please send a PR to add your own library here.

Help

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

License

MIT