1
0
mirror of https://github.com/labstack/echo.git synced 2024-12-16 10:29:24 +02:00
High performance, minimalist Go web framework https://echo.labstack.com/
Go to file
2024-12-12 07:47:56 +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 Shorten Github issue template and add test example 2024-11-22 22:54:55 +02:00
middleware remove jwt middleware 2024-11-25 22:21:56 +02:00
.editorconfig
.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 Add Conditions to Ensure Bind Succeeds with Transfer-Encoding: chunked (#2717) 2024-12-11 12:04:21 +02:00
bind.go Add Conditions to Ensure Bind Succeeds with Transfer-Encoding: chunked (#2717) 2024-12-11 12:04:21 +02:00
binder_external_test.go Add SPDX licence comments to files. See https://spdx.dev/learn/handling-license-info/ (#2604) 2024-03-09 11:21:24 +02:00
binder_test.go Add SPDX licence comments to files. See https://spdx.dev/learn/handling-license-info/ (#2604) 2024-03-09 11:21:24 +02:00
binder.go optimization: struct alignment (#2636) 2024-05-30 22:50:01 +03:00
CHANGELOG.md Update dependencies (dependabot reports https://pkg.go.dev/vuln/GO-2024-3321) (#2721) 2024-12-12 07:47:56 +02:00
codecov.yml Adding Codecov configuration 2020-12-01 05:00:19 +00:00
context_fs_test.go Add SPDX licence comments to files. See https://spdx.dev/learn/handling-license-info/ (#2604) 2024-03-09 11:21:24 +02:00
context_fs.go Add SPDX licence comments to files. See https://spdx.dev/learn/handling-license-info/ (#2604) 2024-03-09 11:21:24 +02:00
context_test.go improve MultipartForm test 2024-10-06 23:53:23 +03:00
context.go optimization: struct alignment (#2636) 2024-05-30 22:50:01 +03:00
echo_fs_test.go tests: In Go 1.23 fs related errors have changed. 2024-08-16 09:16:52 +03:00
echo_fs.go optimization: struct alignment (#2636) 2024-05-30 22:50:01 +03:00
echo_test.go When route is registered with empty path it is normalized to /. Make sure that returned echo.Route structs reflect that behavior. (#2616) 2024-03-27 12:28:46 +02:00
echo.go Update dependencies (dependabot reports https://pkg.go.dev/vuln/GO-2024-3321) (#2721) 2024-12-12 07:47:56 +02:00
go.mod Update dependencies (dependabot reports https://pkg.go.dev/vuln/GO-2024-3321) (#2721) 2024-12-12 07:47:56 +02:00
go.sum Update dependencies (dependabot reports https://pkg.go.dev/vuln/GO-2024-3321) (#2721) 2024-12-12 07:47:56 +02:00
group_fs_test.go tests: In Go 1.23 fs related errors have changed. 2024-08-16 09:16:52 +03:00
group_fs.go Add SPDX licence comments to files. See https://spdx.dev/learn/handling-license-info/ (#2604) 2024-03-09 11:21:24 +02:00
group_test.go Add SPDX licence comments to files. See https://spdx.dev/learn/handling-license-info/ (#2604) 2024-03-09 11:21:24 +02:00
group.go optimization: struct alignment (#2636) 2024-05-30 22:50:01 +03:00
ip_test.go Fix Real IP logic (#2550) 2024-03-10 19:04:54 +02:00
ip.go optimization: struct alignment (#2636) 2024-05-30 22:50:01 +03:00
json_test.go Add SPDX licence comments to files. See https://spdx.dev/learn/handling-license-info/ (#2604) 2024-03-09 11:21:24 +02:00
json.go Add SPDX licence comments to files. See https://spdx.dev/learn/handling-license-info/ (#2604) 2024-03-09 11:21:24 +02:00
LICENSE Create LICENSE 2021-04-17 12:47:48 -07:00
log.go Change type definition blocks to single declarations. This helps copy/pasting Echo code in examples. (#2606) 2024-03-09 07:53:07 -08:00
Makefile CORS middleware should compile allowOrigin regexp at creation. 2024-11-22 11:59:58 +02:00
README.md Shorten Github issue template and add test example 2024-11-22 22:54:55 +02:00
renderer_test.go Add TemplateRenderer struct to ease creating renderers for html/template and text/template packages. 2024-10-20 21:21:51 +03:00
renderer.go Add TemplateRenderer struct to ease creating renderers for html/template and text/template packages. 2024-10-20 21:21:51 +03:00
response_test.go Add SPDX licence comments to files. See https://spdx.dev/learn/handling-license-info/ (#2604) 2024-03-09 11:21:24 +02:00
response.go Remove pre Go1.20 support 2024-08-16 09:16:52 +03:00
router_test.go When route is registered with empty path it is normalized to /. Make sure that returned echo.Route structs reflect that behavior. (#2616) 2024-03-27 12:28:46 +02:00
router.go optimization: struct alignment (#2636) 2024-05-30 22:50:01 +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"
  "log/slog"
  "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(":8080"); err != nil && !errors.Is(err, http.ErrServerClosed) {
    slog.Error("failed to start server", "error", err)
  }
}

// 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