Categorygithub.com/oldfritter/echo/v4
modulepackage
4.6.2
Repository: https://github.com/oldfritter/echo.git
Documentation: pkg.go.dev

# README

Sourcegraph GoDoc Go Report Card Build Status Codecov Join the chat at https://gitter.im/labstack/echo Forum Twitter License

Supported Go 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:

  • 1.9.7+
  • 1.10.3+
  • 1.14+

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 (
  "net/http"
  "github.com/labstack/echo/v4"
  "github.com/labstack/echo/v4/middleware"
)

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

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

# 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.
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.
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.
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.
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.
MIME types.
MIME types.
MIME types.
MIME types.
MIME types.
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.
HTTP methods NOTE: Deprecated, please use the stdlib constants directly instead.
Version of Echo.

# Variables

# Structs

BindingError represents an error that occurred while binding request data.
No description provided by the author
DefaultJSONSerializer implements JSON encoding using encoding/json.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ValueBinder provides utility methods for binding query or path parameter to various Go built-in types.

# Interfaces

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
IPExtractor is a function to extract IP addr from http.Request.
No description provided by the author
No description provided by the author
TrustOption is config for which IP address to trust.