Categorygithub.com/labstack/echo/v4
modulepackage
4.13.3
Repository: https://github.com/labstack/echo.git
Documentation: pkg.go.dev
Overview
Versions
5
Dependencies
30
Dependents
12.9k
Files
4k SLOC

# README

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.

RepositoryDescription
github.com/labstack/echo-jwtJWT middleware
github.com/labstack/echo-contribcasbin, 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.

RepositoryDescription
deepmap/oapi-codegenAutomatically generate RESTful API documentation with OpenAPI Client and Server Code Generator
github.com/swaggo/echo-swaggerAutomatically generate RESTful API documentation with Swagger 2.0.
github.com/ziflex/lechoZerolog logging library wrapper for Echo logger interface.
github.com/brpaz/echozapUber´s Zap logging library wrapper for Echo logger interface.
github.com/samber/slog-echoGo slog logging library wrapper for Echo logger interface.
github.com/darkweak/souin/plugins/echoHTTP 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/pagodaRapid, easy full-stack web development starter kit built with Echo.
github.com/go-woo/protoc-gen-echoProtoBuf 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

# Packages

No description provided by the author

# Functions

ExtractIPDirect extracts IP address using actual IP address.
ExtractIPFromRealIPHeader extracts IP address using x-real-ip header.
ExtractIPFromXFFHeader extracts IP address using x-forwarded-for header.
FormFieldBinder creates form field value binder For all requests, FormFieldBinder parses the raw query from the URL and uses query params as form fields For POST, PUT, and PATCH requests, it also reads the request body, parses it as a form and uses query params as form fields.
GetPath returns RawPath, if it's empty returns Path from URL Difference between RawPath and Path is: - Path is where request path is stored.
MustSubFS creates sub FS from current filesystem or panic on failure.
New creates an instance of Echo.
NewBindingError creates new instance of binding error.
NewHTTPError creates a new HTTPError instance.
NewResponse creates a new instance of Response.
NewRouter returns a new Router instance.
PathParamsBinder creates path parameter value binder.
QueryParamsBinder creates query parameter value binder.
StaticDirectoryHandler creates handler function to serve files from provided file system When disablePathUnescaping is set then file name from path is not unescaped and is served as is.
StaticFileHandler creates handler function to serve file from provided file system.
TrustIPRange add trustable IP ranges using CIDR notation.
TrustLinkLocal configures if you trust link-local address (default: true).
TrustLoopback configures if you trust loopback address (default: true).
TrustPrivateNet configures if you trust private network address (default: true).
WrapHandler wraps `http.Handler` into `echo.HandlerFunc`.
WrapMiddleware wraps `func(http.Handler) http.Handler` into `echo.MiddlewareFunc`.

# Constants

HTTP methods NOTE: Deprecated, please use the stdlib constants directly instead.
ContextKeyHeaderAllow is set by Router for getting value for `Allow` header in later stages of handler call chain.
HTTP methods NOTE: Deprecated, please use the stdlib constants directly instead.
HTTP methods NOTE: Deprecated, please use the stdlib constants directly instead.
HTTP methods NOTE: Deprecated, please use the stdlib constants directly instead.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Access control.
HeaderAllow is the name of the "Allow" header field used to list the set of methods advertised as supported by the target resource.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Security.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
Headers.
MIME types.
MIME types.
MIME types.
MIMEApplicationJSON JavaScript Object Notation (JSON) https://www.rfc-editor.org/rfc/rfc8259.
Deprecated: Please use MIMEApplicationJSON instead.
MIME types.
MIME types.
MIME types.
MIME types.
MIME types.
MIME types.
MIME types.
MIME types.
MIME types.
MIME types.
MIME types.
MIME types.
HTTP methods NOTE: Deprecated, please use the stdlib constants directly instead.
HTTP methods NOTE: Deprecated, please use the stdlib constants directly instead.
POST
HTTP methods NOTE: Deprecated, please use the stdlib constants directly instead.
PROPFIND Method can be used on collection and property resources.
PROPFIND = "PROPFIND".
REPORT Method can be used to get information about a resource, see rfc 3253.
RouteNotFound is special method type for routes handling "route not found" (404) cases.
HTTP methods NOTE: Deprecated, please use the stdlib constants directly instead.
Version of Echo.

# Variables

HTTP 502 Bad Gateway.
HTTP 400 Bad Request.
HTTP 409 Conflict.
Errors.
HTTP 417 Expectation Failed.
HTTP 424 Failed Dependency.
HTTP 403 Forbidden.
HTTP 504 Gateway Timeout.
HTTP 410 Gone.
HTTP 505 HTTP Version Not Supported.
HTTP 507 Insufficient Storage.
HTTP 500 Internal Server Error.
Errors.
Errors.
Errors.
HTTP 411 Length Required.
HTTP 423 Locked.
HTTP 508 Loop Detected.
HTTP 405 Method Not Allowed.
HTTP 421 Misdirected Request.
HTTP 511 Network Authentication Required.
HTTP 406 Not Acceptable.
HTTP 510 Not Extended.
HTTP 404 Not Found.
HTTP 501 Not Implemented.
HTTP 402 Payment Required.
HTTP 412 Precondition Failed.
HTTP 428 Precondition Required.
HTTP 407 Proxy AuthRequired.
Errors.
HTTP 416 Range Not Satisfiable.
HTTP 431 Request Header Fields Too Large.
HTTP 408 Request Timeout.
HTTP 414 URI Too Long.
HTTP 503 Service Unavailable.
HTTP 413 Payload Too Large.
HTTP 418 I'm a teapot.
HTTP 425 Too Early.
HTTP 429 Too Many Requests.
HTTP 401 Unauthorized.
HTTP 451 Unavailable For Legal Reasons.
HTTP 422 Unprocessable Entity.
HTTP 415 Unsupported Media Type.
HTTP 426 Upgrade Required.
Errors.
HTTP 506 Variant Also Negotiates.
MethodNotAllowedHandler is the handler thar router uses in case there was no matching route found but there was another matching routes for that requested URL.
NotFoundHandler is the handler that router uses in case there was no matching route found.

# Structs

BindingError represents an error that occurred while binding request data.
DefaultBinder is the default implementation of the Binder interface.
DefaultJSONSerializer implements JSON encoding using encoding/json.
Echo is the top-level framework instance.
Group is a set of sub-routes for a specified route.
HTTPError represents an error that occurred while handling a request.
Response wraps an http.ResponseWriter and implements its interface to be used by an HTTP handler to construct an HTTP response.
Route contains a handler and information for matching against requests.
Router is the registry of all registered routes for an `Echo` instance for request matching and URL path parameter parsing.
TemplateRenderer is helper to ease creating renderers for `html/template` and `text/template` packages.
ValueBinder provides utility methods for binding query or path parameter to various Go built-in types.

# Interfaces

Binder is the interface that wraps the Bind method.
BindUnmarshaler is the interface used to wrap the UnmarshalParam method.
Context represents the context of the current HTTP request.
JSONSerializer is the interface that encodes and decodes JSON to and from interfaces.
Logger defines the logging interface.
Renderer is the interface that wraps the Render function.
Validator is the interface that wraps the Validate function.

# Type aliases

HandlerFunc defines a function to serve HTTP requests.
HTTPErrorHandler is a centralized HTTP error handler.
IPExtractor is a function to extract IP addr from http.Request.
Map defines a generic map of type `map[string]interface{}`.
MiddlewareFunc defines a function to process middleware.
TrustOption is config for which IP address to trust.