1
0
mirror of https://github.com/labstack/echo.git synced 2024-12-24 20:14:31 +02:00
High performance, minimalist Go web framework https://echo.labstack.com/
Go to file
teslaedison 34717b717d
fix some typos (#2603)
Signed-off-by: teslaedison <qingchengqiushuang@gmail.com>
2024-03-06 21:43:59 +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 CI: Use Go 1.22 2024-02-07 07:54:21 +02:00
middleware fix some typos (#2603) 2024-03-06 21:43:59 +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 binder: allow binding to a nil map 2024-02-13 20:16:18 +02:00
bind.go binder: allow binding to a nil map 2024-02-13 20:16:18 +02: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 refactor context tests to be separate functions (#2540) 2023-11-07 13:40:22 +02:00
CHANGELOG.md Changelog for v4.11.4 (#2564) 2023-12-20 15:24:30 +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 default charset from 'application/json' Content-Type header (#2568) 2024-02-06 07:41:33 +02:00
context.go fix some typos (#2603) 2024-03-06 21:43:59 +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 In Go 1.22 finding name of function with reflection has changed. change tests to work with that. 2024-02-07 07:54:21 +02:00
echo.go fix some typos (#2603) 2024-03-06 21:43:59 +02:00
go.mod Update deps and mark Go version to 1.18 as this is what golang.org/x/* use. (#2563) 2023-12-20 15:17:20 +02:00
go.sum Update deps and mark Go version to 1.18 as this is what golang.org/x/* use. (#2563) 2023-12-20 15:17:20 +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 Fix group.RouteNotFound not working when group has attached middlewares 2023-03-02 23:14:52 +02:00
group.go Fix group.RouteNotFound not working when group has attached middlewares 2023-03-02 23:14:52 +02:00
ip_test.go Remove square brackets from ipv6 addresses in XFF (#2182) 2022-11-24 22:17:31 +02:00
ip.go fix some typos (#2603) 2024-03-06 21:43:59 +02:00
json_test.go refactor context tests to be separate functions (#2540) 2023-11-07 13:40:22 +02: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 Reorder paragraphs in README.md (#2581) 2024-01-24 07:45:40 -08:00
response_test.go add supprt for go1.20 http.rwUnwrapper 2023-04-06 13:37:41 +03:00
response.go add supprt for go1.20 http.rwUnwrapper 2023-04-06 13:37:41 +03:00
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 fix misuses of a vs an 2023-04-22 21:37:45 +03:00

Sourcegraph GoDoc Go Report Card GitHub Workflow Status (with event) Codecov Forum Twitter License

Echo

High performance, extensible, minimalist Go web framework.

Help and questions: Github Discussions

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

Sponsors


Click here for more information on sponsorship.

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

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

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/samber/slog-echo Go slog 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.

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