1
0
mirror of https://github.com/labstack/echo.git synced 2024-12-22 20:06:21 +02:00
High performance, minimalist Go web framework https://echo.labstack.com/
Go to file
2023-07-22 23:39:02 +03: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 Changes from master (from 70acd57105 to 5b36ce3612) 2023-07-22 23:39:01 +03:00
middleware minimize references to external types (rate.Limit) 2023-07-22 23:39:02 +03: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 Bring over changes from master (latest commit 135c511f5d) 2023-07-22 23:39:00 +03:00
bind.go V5.0.0-alpha 2022-05-22 00:35:33 +03:00
binder_external_test.go V5.0.0-alpha 2022-05-22 00:35:33 +03:00
binder_test.go V5.0.0-alpha 2022-05-22 00:35:33 +03:00
binder.go V5.0.0-alpha 2022-05-22 00:35:33 +03:00
CHANGELOG.md Bring over changes from master (latest commit 135c511f5d) 2023-07-22 23:39:00 +03:00
codecov.yml Adding Codecov configuration 2020-12-01 05:00:19 +00:00
context_test.go Bring over changes from master (latest commit 135c511f5d) 2023-07-22 23:39:00 +03:00
context.go Bring over changes from master (latest commit 135c511f5d) 2023-07-22 23:39:00 +03:00
echo_test.go Bring over changes from master (latest commit f36d5662fb) 2023-07-22 23:39:01 +03:00
echo.go Bring over changes from master (latest commit f36d5662fb) 2023-07-22 23:39:01 +03:00
go.mod Changes from master (from 70acd57105 to 5b36ce3612) 2023-07-22 23:39:01 +03:00
go.sum Changes from master (from 70acd57105 to 5b36ce3612) 2023-07-22 23:39:01 +03:00
group_test.go Bring over changes from master (latest commit 135c511f5d) 2023-07-22 23:39:00 +03:00
group.go Changes from master (from 70acd57105 to 70acd57105) 2022-07-17 22:19:09 +03:00
httperror_test.go V5.0.0-alpha 2022-05-22 00:35:33 +03:00
httperror.go V5.0.0-alpha 2022-05-22 00:35:33 +03:00
ip_test.go Bring over changes from master (latest commit 135c511f5d) 2023-07-22 23:39:00 +03:00
ip.go Bring over changes from master (latest commit 135c511f5d) 2023-07-22 23:39:00 +03:00
json_test.go Bring over changes from master (latest commit 135c511f5d) 2023-07-22 23:39:00 +03:00
json.go V5.0.0-alpha 2022-05-22 00:35:33 +03:00
LICENSE V5.0.0-alpha 2022-05-22 00:35:33 +03:00
log_test.go V5.0.0-alpha 2022-05-22 00:35:33 +03:00
log.go V5.0.0-alpha 2022-05-22 00:35:33 +03:00
Makefile Changes from master (from 70acd57105 to 5b36ce3612) 2023-07-22 23:39:01 +03:00
README.md Changes from master (from 70acd57105 to 5b36ce3612) 2023-07-22 23:39:01 +03: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 V5.0.0-alpha 2022-05-22 00:35:33 +03:00
route_test.go V5.0.0-alpha 2022-05-22 00:35:33 +03:00
route.go V5.0.0-alpha 2022-05-22 00:35:33 +03:00
router_test.go Changes from master (from 70acd57105 to 5b36ce3612) 2023-07-22 23:39:01 +03:00
router.go Bring over changes from master (latest commit f36d5662fb) 2023-07-22 23:39:01 +03:00
server_test.go Bring over changes from master (latest commit 135c511f5d) 2023-07-22 23:39:00 +03:00
server.go improve docs 2023-07-22 23:39:02 +03: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

Guide

Installation

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

Example

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!")
}

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