1
2

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

package main

import (
  "net/http"

  "github.com/labstack/echo/v4"
  "github.com/labstack/echo/v4/middleware"
)

// 处理函数
func hello(c echo.Context) error {
  return c.String(http.StatusOK, "Hello, World!")
}

func main() {
  // 创建 Echo 实例
  e := echo.New()

  // 中间件
  e.Use(middleware.Logger())
  e.Use(middleware.Recover())

  // 路由
  e.GET("/", hello)

  // 启动服务器
  e.Logger.Fatal(e.Start(":1323"))
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

const (
	CONNECT = http.MethodConnect
	DELETE  = http.MethodDelete
	GET     = http.MethodGet
	HEAD    = http.MethodHead
	OPTIONS = http.MethodOptions
	PATCH   = http.MethodPatch
	POST    = http.MethodPost
	// PROPFIND = "PROPFIND"
	PUT   = http.MethodPut
	TRACE = http.MethodTrace
)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

const (
	MIMEApplicationJSON                  = "application/json"
	MIMEApplicationJSONCharsetUTF8       = MIMEApplicationJSON + "; " + charsetUTF8
	MIMEApplicationJavaScript            = "application/javascript"
	MIMEApplicationJavaScriptCharsetUTF8 = MIMEApplicationJavaScript + "; " + charsetUTF8
	MIMEApplicationXML                   = "application/xml"
	MIMEApplicationXMLCharsetUTF8        = MIMEApplicationXML + "; " + charsetUTF8
	MIMETextXML                          = "text/xml"
	MIMETextXMLCharsetUTF8               = MIMETextXML + "; " + charsetUTF8
	MIMEApplicationForm                  = "application/x-www-form-urlencoded"
	MIMEApplicationProtobuf              = "application/protobuf"
	MIMEApplicationMsgpack               = "application/msgpack"
	MIMETextHTML                         = "text/html"
	MIMETextHTMLCharsetUTF8              = MIMETextHTML + "; " + charsetUTF8
	MIMETextPlain                        = "text/plain"
	MIMETextPlainCharsetUTF8             = MIMETextPlain + "; " + charsetUTF8
	MIMEMultipartForm                    = "multipart/form-data"
	MIMEOctetStream                      = "application/octet-stream"
)

1
2
3
4
5
6
7
8
9

const (

    // PROPFIND 方法可用于集合和属性资源。
	PROPFIND = "PROPFIND"
    // REPORT 方法可用于获取有关资源的信息，参见 rfc 3253
	REPORT = "REPORT"
    // RouteNotFound 是用于处理 "route not found"（404）情况的特殊方法类型
	RouteNotFound = "echo_route_not_found"
)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

const (
	HeaderAccept         = "Accept"
	HeaderAcceptEncoding = "Accept-Encoding"
    // HeaderAllow 是 "Allow" 头字段的名称，用于列出目标资源支持的方法集。
	// 对于状态 405（method not found）返回 Allow 头字段是必需的，并且对 OPTIONS 方法的响应很有用。
	// 参见 RFC 7231：https://datatracker.ietf.org/doc/html/rfc7231#section-7.4.1
	HeaderAllow               = "Allow"
	HeaderAuthorization       = "Authorization"
	HeaderContentDisposition  = "Content-Disposition"
	HeaderContentEncoding     = "Content-Encoding"
	HeaderContentLength       = "Content-Length"
	HeaderContentType         = "Content-Type"
	HeaderCookie              = "Cookie"
	HeaderSetCookie           = "Set-Cookie"
	HeaderIfModifiedSince     = "If-Modified-Since"
	HeaderLastModified        = "Last-Modified"
	HeaderLocation            = "Location"
	HeaderRetryAfter          = "Retry-After"
	HeaderUpgrade             = "Upgrade"
	HeaderVary                = "Vary"
	HeaderWWWAuthenticate     = "WWW-Authenticate"
	HeaderXForwardedFor       = "X-Forwarded-For"
	HeaderXForwardedProto     = "X-Forwarded-Proto"
	HeaderXForwardedProtocol  = "X-Forwarded-Protocol"
	HeaderXForwardedSsl       = "X-Forwarded-Ssl"
	HeaderXUrlScheme          = "X-Url-Scheme"
	HeaderXHTTPMethodOverride = "X-HTTP-Method-Override"
	HeaderXRealIP             = "X-Real-Ip"
	HeaderXRequestID          = "X-Request-Id"
	HeaderXCorrelationID      = "X-Correlation-Id"
	HeaderXRequestedWith      = "X-Requested-With"
	HeaderServer              = "Server"
	HeaderOrigin              = "Origin"
	HeaderCacheControl        = "Cache-Control"
	HeaderConnection          = "Connection"
    
    // 访问控制
	HeaderAccessControlRequestMethod    = "Access-Control-Request-Method"
	HeaderAccessControlRequestHeaders   = "Access-Control-Request-Headers"
	HeaderAccessControlAllowOrigin      = "Access-Control-Allow-Origin"
	HeaderAccessControlAllowMethods     = "Access-Control-Allow-Methods"
	HeaderAccessControlAllowHeaders     = "Access-Control-Allow-Headers"
	HeaderAccessControlAllowCredentials = "Access-Control-Allow-Credentials"
	HeaderAccessControlExposeHeaders    = "Access-Control-Expose-Headers"
	HeaderAccessControlMaxAge           = "Access-Control-Max-Age"

    // 安全
	HeaderStrictTransportSecurity         = "Strict-Transport-Security"
	HeaderXContentTypeOptions             = "X-Content-Type-Options"
	HeaderXXSSProtection                  = "X-XSS-Protection"
	HeaderXFrameOptions                   = "X-Frame-Options"
	HeaderContentSecurityPolicy           = "Content-Security-Policy"
	HeaderContentSecurityPolicyReportOnly = "Content-Security-Policy-Report-Only"
	HeaderXCSRFToken                      = "X-CSRF-Token"
	HeaderReferrerPolicy                  = "Referrer-Policy"
)

1
2
3
4
5
6

const (
    // ContextKeyHeaderAllow 由 Router 设置，用于在处理程序调用链的后续阶段获取 "Allow" 头字段的值。
	// 对于状态 405（method not found）返回 Allow 头字段是必需的，并且对 OPTIONS 方法的响应很有用。
	// 仅当 Router 在请求中找不到匹配的方法处理程序时，才将其添加到上下文中。
	ContextKeyHeaderAllow = "echo_header_allow"
)

1
2
3
4

const (
    // Echo 的版本
	Version = "4.11.1"
)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

var (
	ErrBadRequest                    = NewHTTPError(http.StatusBadRequest)                    // HTTP 400 Bad Request
	ErrUnauthorized                  = NewHTTPError(http.StatusUnauthorized)                  // HTTP 401 Unauthorized
	ErrPaymentRequired               = NewHTTPError(http.StatusPaymentRequired)               // HTTP 402 Payment Required
	ErrForbidden                     = NewHTTPError(http.StatusForbidden)                     // HTTP 403 Forbidden
	ErrNotFound                      = NewHTTPError(http.StatusNotFound)                      // HTTP 404 Not Found
	ErrMethodNotAllowed              = NewHTTPError(http.StatusMethodNotAllowed)              // HTTP 405 Method Not Allowed
	ErrNotAcceptable                 = NewHTTPError(http.StatusNotAcceptable)                 // HTTP 406 Not Acceptable
	ErrProxyAuthRequired             = NewHTTPError(http.StatusProxyAuthRequired)             // HTTP 407 Proxy AuthRequired
	ErrRequestTimeout                = NewHTTPError(http.StatusRequestTimeout)                // HTTP 408 Request Timeout
	ErrConflict                      = NewHTTPError(http.StatusConflict)                      // HTTP 409 Conflict
	ErrGone                          = NewHTTPError(http.StatusGone)                          // HTTP 410 Gone
	ErrLengthRequired                = NewHTTPError(http.StatusLengthRequired)                // HTTP 411 Length Required
	ErrPreconditionFailed            = NewHTTPError(http.StatusPreconditionFailed)            // HTTP 412 Precondition Failed
	ErrStatusRequestEntityTooLarge   = NewHTTPError(http.StatusRequestEntityTooLarge)         // HTTP 413 Payload Too Large
	ErrRequestURITooLong             = NewHTTPError(http.StatusRequestURITooLong)             // HTTP 414 URI Too Long
	ErrUnsupportedMediaType          = NewHTTPError(http.StatusUnsupportedMediaType)          // HTTP 415 Unsupported Media Type
	ErrRequestedRangeNotSatisfiable  = NewHTTPError(http.StatusRequestedRangeNotSatisfiable)  // HTTP 416 Range Not Satisfiable
	ErrExpectationFailed             = NewHTTPError(http.StatusExpectationFailed)             // HTTP 417 Expectation Failed
	ErrTeapot                        = NewHTTPError(http.StatusTeapot)                        // HTTP 418 I'm a teapot
	ErrMisdirectedRequest            = NewHTTPError(http.StatusMisdirectedRequest)            // HTTP 421 Misdirected Request
	ErrUnprocessableEntity           = NewHTTPError(http.StatusUnprocessableEntity)           // HTTP 422 Unprocessable Entity
	ErrLocked                        = NewHTTPError(http.StatusLocked)                        // HTTP 423 Locked
	ErrFailedDependency              = NewHTTPError(http.StatusFailedDependency)              // HTTP 424 Failed Dependency
	ErrTooEarly                      = NewHTTPError(http.StatusTooEarly)                      // HTTP 425 Too Early
	ErrUpgradeRequired               = NewHTTPError(http.StatusUpgradeRequired)               // HTTP 426 Upgrade Required
	ErrPreconditionRequired          = NewHTTPError(http.StatusPreconditionRequired)          // HTTP 428 Precondition Required
	ErrTooManyRequests               = NewHTTPError(http.StatusTooManyRequests)               // HTTP 429 Too Many Requests
	ErrRequestHeaderFieldsTooLarge   = NewHTTPError(http.StatusRequestHeaderFieldsTooLarge)   // HTTP 431 Request Header Fields Too Large
	ErrUnavailableForLegalReasons    = NewHTTPError(http.StatusUnavailableForLegalReasons)    // HTTP 451 Unavailable For Legal Reasons
	ErrInternalServerError           = NewHTTPError(http.StatusInternalServerError)           // HTTP 500 Internal Server Error
	ErrNotImplemented                = NewHTTPError(http.StatusNotImplemented)                // HTTP 501 Not Implemented
	ErrBadGateway                    = NewHTTPError(http.StatusBadGateway)                    // HTTP 502 Bad Gateway
	ErrServiceUnavailable            = NewHTTPError(http.StatusServiceUnavailable)            // HTTP 503 Service Unavailable
	ErrGatewayTimeout                = NewHTTPError(http.StatusGatewayTimeout)                // HTTP 504 Gateway Timeout
	ErrHTTPVersionNotSupported       = NewHTTPError(http.StatusHTTPVersionNotSupported)       // HTTP 505 HTTP Version Not Supported
	ErrVariantAlsoNegotiates         = NewHTTPError(http.StatusVariantAlsoNegotiates)         // HTTP 506 Variant Also Negotiates
	ErrInsufficientStorage           = NewHTTPError(http.StatusInsufficientStorage)           // HTTP 507 Insufficient Storage
	ErrLoopDetected                  = NewHTTPError(http.StatusLoopDetected)                  // HTTP 508 Loop Detected
	ErrNotExtended                   = NewHTTPError(http.StatusNotExtended)                   // HTTP 510 Not Extended
	ErrNetworkAuthenticationRequired = NewHTTPError(http.StatusNetworkAuthenticationRequired) // HTTP 511 Network Authentication Required

	ErrValidatorNotRegistered = errors.New("validator not registered")
	ErrRendererNotRegistered  = errors.New("renderer not registered")
	ErrInvalidRedirectCode    = errors.New("invalid redirect status code")
	ErrCookieNotFound         = errors.New("cookie not found")
	ErrInvalidCertOrKeyType   = errors.New("invalid cert or key type, must be string or []byte")
	ErrInvalidListenerNetwork = errors.New("invalid listener network")
)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

var (
	NotFoundHandler = func(c Context) error {
		return ErrNotFound
	}

	MethodNotAllowedHandler = func(c Context) error {

		routerAllowMethods, ok := c.Get(ContextKeyHeaderAllow).(string)
		if ok && routerAllowMethods != "" {
			c.Response().Header().Set(HeaderAllow, routerAllowMethods)
		}
		return ErrMethodNotAllowed
	}
)

1

func GetPath(r *http.Request) string

1

func MustSubFS(currentFs fs.FS, fsRoot string) fs.FS

1

func NewBindingError(sourceParam string, values []string, message interface{}, internalError error) error

1
2
3
4

type BindUnmarshaler interface {
    // UnmarshalParam 解码并从表单或查询参数中分配一个值。
	UnmarshalParam(param string) error
}

1
2
3

type Binder interface {
	Bind(i interface{}, c Context) error
}

1
2
3
4
5
6
7

type BindingError struct {
    // Field 是值绑定失败的字段名
	Field string `json:"field"`
    // Values 是无法绑定的参数值。
	Values []string `json:"-"`
	*HTTPError
}

1

func (be *BindingError) Error() string

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177

type Context interface {
    // Request 返回 `*http.Request`。
	Request() *http.Request

    // SetRequest 设置 `*http.Request`。
	SetRequest(r *http.Request)

    // SetResponse 设置 `*Response`。
	SetResponse(r *Response)

    // Response 返回 `*Response`。
	Response() *Response

    // IsTLS 如果 HTTP 连接是 TLS 则返回 true，否则返回 false。
	IsTLS() bool

    // IsWebSocket 如果 HTTP 连接是 WebSocket 则返回 true，否则返回 false。
	IsWebSocket() bool

    // Scheme 返回 HTTP 协议方案，`http` 或 `https`。
	Scheme() string

    // RealIP 返回基于 `X-Forwarded-For` 或 `X-Real-IP` 请求头的客户端网络地址。
	// 可以使用 `Echo#IPExtractor` 配置行为。
	RealIP() string

    // Path 返回处理程序的注册路径。
	Path() string

    // SetPath 设置处理程序的注册路径。
	SetPath(p string)

    // Param 返回指定名称的路径参数。
	Param(name string) string

    // ParamNames 返回路径参数的名称。
	ParamNames() []string

    // SetParamNames 设置路径参数的名称。
	SetParamNames(names ...string)

    // ParamValues 返回路径参数的值。
	ParamValues() []string

    // SetParamValues 设置路径参数的值。
	SetParamValues(values ...string)

    // QueryParam 返回提供名称的查询参数。
	QueryParam(name string) string

    // QueryParams 返回查询参数作为 `url.Values`。
	QueryParams() url.Values

    // QueryString 返回 URL 查询字符串。
	QueryString() string

    // FormValue 返回提供名称的表单字段值。
	FormValue(name string) string

    // FormParams 返回表单参数作为 `url.Values`。
	FormParams() (url.Values, error)

    // FormFile 返回提供名称的多部分表单文件。
	FormFile(name string) (*multipart.FileHeader, error)

    // MultipartForm 返回多部分表单。
	MultipartForm() (*multipart.Form, error)

    // Cookie 返回请求中提供的指定名称的 cookie。
	Cookie(name string) (*http.Cookie, error)

    // SetCookie 在 HTTP 响应中添加 `Set-Cookie` 标头。
	SetCookie(cookie *http.Cookie)

    // Cookies 返回发送到请求的 HTTP cookie。
	Cookies() []*http.Cookie

    // Get 检索上下文中的数据。
	Get(key string) interface{}

    // Set 在上下文中保存数据。
	Set(key string, val interface{})

    // Bind 将路径参数、查询参数和请求体绑定到提供的类型 `i`。默认的绑定器
	// 基于 Content-Type 头绑定请求体。
	Bind(i interface{}) error

    // Validate 验证提供的 `i`。通常在 `Context#Bind()` 之后调用。
	// 验证器必须使用 `Echo#Validator` 进行注册。
	Validate(i interface{}) error

    // Render 使用数据渲染模板并以文本/HTML 响应的状态
	// 代码发送响应。必须使用 `Echo.Renderer` 进行注册。
	Render(code int, name string, data interface{}) error

    // HTML 以状态代码发送带有 HTML 内容的 HTTP 响应。
	HTML(code int, html string) error

    // HTMLBlob 以状态代码发送带有 HTML 内容的 HTTP blob 响应。
	HTMLBlob(code int, b []byte) error

    // String 以状态代码发送带有字符串内容的响应。
	String(code int, s string) error

    // JSON 以状态代码发送带有 JSON 内容的响应。
	JSON(code int, i interface{}) error

    // JSONPretty 以状态代码发送带有漂亮格式的 JSON 内容。
	JSONPretty(code int, i interface{}, indent string) error

    // JSONBlob 以状态代码发送带有 JSON blob 内容的响应。
	JSONBlob(code int, b []byte) error

    // JSONP 以状态代码发送带有 JSONP 内容的响应。它使用 `callback` 构造
	// JSONP 载荷。
	JSONP(code int, callback string, i interface{}) error

    // JSONPBlob 以状态代码发送带有 JSONP blob 内容的响应。它使用 `callback`
	// 构造 JSONP 载荷。
	JSONPBlob(code int, callback string, b []byte) error

    // XML 以状态代码发送带有 XML 内容的响应。
	XML(code int, i interface{}) error

    // XMLPretty 以状态代码发送带有漂亮格式的 XML 内容。
	XMLPretty(code int, i interface{}, indent string) error

    // XMLBlob 以状态代码发送带有 XML blob 内容的响应。
	XMLBlob(code int, b []byte) error

    // Blob 以状态代码和内容类型发送 blob 响应。
	Blob(code int, contentType string, b []byte) error

    // Stream 以状态代码和内容类型发送流响应。
	Stream(code int, contentType string, r io.Reader) error

   // File 发送包含文件内容的响应。
	File(file string) error

    // Attachment 以附件形式发送响应，提示客户端保存文件。
	Attachment(file string, name string) error

    // Inline 以内联形式发送响应，将文件在浏览器中打开。
	Inline(file string, name string) error

    // NoContent 以没有响应体的形式发送响应，并返回状态代码。
	NoContent(code int) error

    // Redirect 以指定的状态代码将请求重定向到提供的 URL。
	Redirect(code int, url string) error

    // Error 调用注册的全局 HTTP 错误处理程序。通常由中间件使用。
	// 调用全局错误处理程序的副作用是 Response 已经提交（发送到客户端），
	// 链中的中间件现在不能再更改 Response 状态代码或 Response 主体。
	//
	// 避免在处理程序中使用此方法，因为在此之后没有中间件能够有效地处理错误。
	Error(err error)

    // Handler 返回与路由器匹配的处理程序。
	Handler() HandlerFunc

    // SetHandler 设置与路由器匹配的处理程序。
	SetHandler(h HandlerFunc)

    // Logger 返回 `Logger` 实例。
	Logger() Logger

    // SetLogger 设置日志记录器
	SetLogger(l Logger)

    // Echo 返回 `Echo` 实例。
	Echo() *Echo

    // Reset 在请求完成后重置上下文。必须与 `Echo#AcquireContext()` 和 `Echo#ReleaseContext()` 一起调用。
	// 见 `Echo#ServeHTTP()`
	Reset(r *http.Request, w http.ResponseWriter)
}

1

type DefaultBinder struct{}

1

func (b *DefaultBinder) Bind(i interface{}, c Context) (err error)

1

func (b *DefaultBinder) BindBody(c Context, i interface{}) (err error)

1

func (b *DefaultBinder) BindHeaders(c Context, i interface{}) error

1

func (b *DefaultBinder) BindPathParams(c Context, i interface{}) error

1

func (b *DefaultBinder) BindQueryParams(c Context, i interface{}) error

1

type DefaultJSONSerializer struct{}

1

func (d DefaultJSONSerializer) Deserialize(c Context, i interface{}) error

1

func (d DefaultJSONSerializer) Serialize(c Context, i interface{}, indent string) error

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

type Echo struct {
	StdLogger        *stdLog.Logger
	Server           *http.Server
	TLSServer        *http.Server
	Listener         net.Listener
	TLSListener      net.Listener
	AutoTLSManager   autocert.Manager
	DisableHTTP2     bool
	Debug            bool
	HideBanner       bool
	HidePort         bool
	HTTPErrorHandler HTTPErrorHandler
	Binder           Binder
	JSONSerializer   JSONSerializer
	Validator        Validator
	Renderer         Renderer
	Logger           Logger
	IPExtractor      IPExtractor
	ListenerNetwork  string

    // OnAddRouteHandler 在 Echo 添加新路由到特定主机路由器时调用。
	OnAddRouteHandler func(host string, route Route, handler HandlerFunc, middleware []MiddlewareFunc)
	// contains filtered or unexported fields
}

1

func New() (e *Echo)

1

func (e *Echo) AcquireContext() Context

1

func (e *Echo) Add(method, path string, handler HandlerFunc, middleware ...MiddlewareFunc) *Route

1

func (e *Echo) Any(path string, handler HandlerFunc, middleware ...MiddlewareFunc) []*Route

1

func (e *Echo) CONNECT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1

func (e *Echo) Close() error

1

func (e *Echo) DELETE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1

func (e *Echo) DefaultHTTPErrorHandler(err error, c Context)

1

func (e *Echo) File(path, file string, m ...MiddlewareFunc) *Route

1

func (e *Echo) FileFS(path, file string, filesystem fs.FS, m ...MiddlewareFunc) *Route

1

func (e *Echo) GET(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1

func (e *Echo) Group(prefix string, m ...MiddlewareFunc) (g *Group)

1

func (e *Echo) HEAD(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1

func (e *Echo) Host(name string, m ...MiddlewareFunc) (g *Group)

1

func (e *Echo) ListenerAddr() net.Addr

1

func (e *Echo) Match(methods []string, path string, handler HandlerFunc, middleware ...MiddlewareFunc) []*Route

1

func (e *Echo) NewContext(r *http.Request, w http.ResponseWriter) Context

1

func (e *Echo) OPTIONS(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1

func (e *Echo) PATCH(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1

func (e *Echo) POST(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1

func (e *Echo) PUT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1

func (e *Echo) Pre(middleware ...MiddlewareFunc)

1

func (e *Echo) ReleaseContext(c Context)

1

func (e *Echo) Reverse(name string, params ...interface{}) string

1

func (e *Echo) RouteNotFound(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1
2
3

e.RouteNotFound("/*", func(c echo.Context) error { 
	return c.NoContent(http.StatusNotFound) 
})

1

func (e *Echo) Router() *Router

1

func (e *Echo) Routers() map[string]*Router

1

func (e *Echo) Routes() []*Route

1

func (e *Echo) ServeHTTP(w http.ResponseWriter, r *http.Request)

1

func (e *Echo) Shutdown(ctx stdContext.Context) error

1

func (e *Echo) Start(address string) error

1

func (e *Echo) StartAutoTLS(address string) error

1

func (e *Echo) StartH2CServer(address string, h2s *http2.Server) error

1

func (e *Echo) StartServer(s *http.Server) (err error)

1

func (e *Echo) StartTLS(address string, certFile, keyFile interface{}) (err error)

1

func (e *Echo) Static(pathPrefix, fsRoot string) *Route

1

func (e *Echo) StaticFS(pathPrefix string, filesystem fs.FS) *Route

1

func (e *Echo) TLSListenerAddr() net.Addr

1

func (e *Echo) TRACE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1

func (e *Echo) URI(handler HandlerFunc, params ...interface{}) string

1

func (e *Echo) URL(h HandlerFunc, params ...interface{}) string

1

func (e *Echo) Use(middleware ...MiddlewareFunc)

1
2
3

type Group struct {
	// contains filtered or unexported fields
}

1

func (g *Group) Add(method, path string, handler HandlerFunc, middleware ...MiddlewareFunc) *Route

1

func (g *Group) Any(path string, handler HandlerFunc, middleware ...MiddlewareFunc) []*Route

1

func (g *Group) CONNECT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1

func (g *Group) DELETE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1

func (g *Group) File(path, file string)

1

func (g *Group) FileFS(path, file string, filesystem fs.FS, m ...MiddlewareFunc) *Route

1

func (g *Group) GET(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1

func (g *Group) Group(prefix string, middleware ...MiddlewareFunc) (sg *Group)

1

func (g *Group) HEAD(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1

func (g *Group) Match(methods []string, path string, handler HandlerFunc, middleware ...MiddlewareFunc) []*Route

1

func (g *Group) OPTIONS(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1

func (g *Group) PATCH(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1

func (g *Group) POST(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1

func (g *Group) PUT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1

func (g *Group) RouteNotFound(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1
2
3

g.RouteNotFound("/*", func(c echo.Context) error { 
    return c.NoContent(http.StatusNotFound) 
})

1

func (g *Group) Static(pathPrefix, fsRoot string)

1

func (g *Group) StaticFS(pathPrefix string, filesystem fs.FS)

1

func (g *Group) TRACE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route

1

func (g *Group) Use(middleware ...MiddlewareFunc)

1
2
3
4
5

type HTTPError struct {
	Code     int         `json:"-"`
	Message  interface{} `json:"message"`
	Internal error       `json:"-"` // Stores the error returned by an external dependency  存储外部依赖返回的错误
}

1

func NewHTTPError(code int, message ...interface{}) *HTTPError

1

func (he *HTTPError) Error() string

1

func (he *HTTPError) SetInternal(err error) *HTTPError

1

func (he *HTTPError) Unwrap() error

1
2
3
4
5
6
7

func (he *HTTPError) WithInternal(err error) *HTTPError {
	return &HTTPError{
		Code:     he.Code,
		Message:  he.Message,
		Internal: err,
	}
}

1

type HTTPErrorHandler func(err error, c Context)

1

type HandlerFunc func(c Context) error

1

func StaticDirectoryHandler(fileSystem fs.FS, disablePathUnescaping bool) HandlerFunc

1

func StaticFileHandler(file string, filesystem fs.FS) HandlerFunc

1

func WrapHandler(h http.Handler) HandlerFunc

1

type IPExtractor func(*http.Request) string

1

func ExtractIPDirect() IPExtractor

1

func ExtractIPFromRealIPHeader(options ...TrustOption) IPExtractor

1

func ExtractIPFromXFFHeader(options ...TrustOption) IPExtractor

1
2
3
4

type JSONSerializer interface {
	Serialize(c Context, i interface{}, indent string) error
	Deserialize(c Context, i interface{}) error
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

type Logger interface {
	Output() io.Writer
	SetOutput(w io.Writer)
	Prefix() string
	SetPrefix(p string)
	Level() log.Lvl
	SetLevel(v log.Lvl)
	SetHeader(h string)
	Print(i ...interface{})
	Printf(format string, args ...interface{})
	Printj(j log.JSON)
	Debug(i ...interface{})
	Debugf(format string, args ...interface{})
	Debugj(j log.JSON)
	Info(i ...interface{})
	Infof(format string, args ...interface{})
	Infoj(j log.JSON)
	Warn(i ...interface{})
	Warnf(format string, args ...interface{})
	Warnj(j log.JSON)
	Error(i ...interface{})
	Errorf(format string, args ...interface{})
	Errorj(j log.JSON)
	Fatal(i ...interface{})
	Fatalj(j log.JSON)
	Fatalf(format string, args ...interface{})
	Panic(i ...interface{})
	Panicj(j log.JSON)
	Panicf(format string, args ...interface{})
}

1

type Map map[string]interface{}

1

type MiddlewareFunc func(next HandlerFunc) HandlerFunc

1

func WrapMiddleware(m func(http.Handler) http.Handler) MiddlewareFunc

1
2
3

type Renderer interface {
	Render(io.Writer, string, interface{}, Context) error
}

1
2
3
4
5
6
7

type Response struct {
	Writer    http.ResponseWriter
	Status    int
	Size      int64
	Committed bool
	// 包含过滤或未导出的字段
}

1

func NewResponse(w http.ResponseWriter, e *Echo) (r *Response)

1

func (r *Response) After(fn func())

1

func (r *Response) Before(fn func())

1

func (r *Response) Flush()

1

func (r *Response) Header() http.Header

1

func (r *Response) Hijack() (net.Conn, *bufio.ReadWriter, error)

1

func (r *Response) Unwrap() http.ResponseWriter

1

func (r *Response) Write(b []byte) (n int, err error)

1

func (r *Response) WriteHeader(code int)

1
2
3
4
5

type Route struct {
	Method string `json:"method"`
	Path   string `json:"path"`
	Name   string `json:"name"`
}

1
2
3

type Router struct {
    // 包含被过滤或不导出的字段
}

1

func NewRouter(e *Echo) *Router

1

func (r *Router) Add(method, path string, h HandlerFunc)

1

func (r *Router) Find(method, path string, c Context)

1

func (r *Router) Reverse(name string, params ...interface{}) string

1

func (r *Router) Routes() []*Route

1

type TrustOption func(*ipChecker)

1

func TrustIPRange(ipRange *net.IPNet) TrustOption

1

func TrustLinkLocal(v bool) TrustOption

1

func TrustLoopback(v bool) TrustOption

1

func TrustPrivateNet(v bool) TrustOption

1
2
3

type Validator interface {
	Validate(i interface{}) error
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

type ValueBinder struct {

    // ValueFunc 用于从请求中获取单个参数（第一个）的值
	ValueFunc func(sourceParam string) string
    // ValuesFunc 用于从请求中获取参数的所有值。例如：`/api/search?ids=1&ids=2`
	ValuesFunc func(sourceParam string) []string
    // ErrorFunc 用于创建错误。允许您使用自己的错误类型，例如：将其编组为特定的 JSON 响应
	ErrorFunc func(sourceParam string, values []string, message interface{}, internalError error) error
	// 包含被过滤或不导出的字段
}

1

func FormFieldBinder(c Context) *ValueBinder

1

func PathParamsBinder(c Context) *ValueBinder

1

func QueryParamsBinder(c Context) *ValueBinder

1

func (b *ValueBinder) BindError() error

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

// 示例路由函数，将查询参数绑定到不同的目标，并在出现第一个绑定错误时停止绑定
failFastRouteFunc := func(c echo.Context) error {
	var opts struct {
		Active bool
		IDs    []int64
	}
	length := int64(50) // default length is 50

    // 创建一个绑定器（binder），在出现第一个错误时停止绑定。
	b := echo.QueryParamsBinder(c)

	err := b.Int64("length", &length).
		Int64s("ids", &opts.IDs).
		Bool("active", &opts.Active).
		BindError() // returns first binding error
	if err != nil {
		bErr := err.(*echo.BindingError)
		return fmt.Errorf("my own custom error for field: %s values: %v", bErr.Field, bErr.Values)
	}
	fmt.Printf("active = %v, length = %v, ids = %v\n", opts.Active, length, opts.IDs)

	return c.JSON(http.StatusOK, opts)
}

e := echo.New()
c := e.NewContext(
	httptest.NewRequest(http.MethodGet, "/api/endpoint?active=true&length=25&ids=1&ids=2&ids=3", nil),
	httptest.NewRecorder(),
)

_ = failFastRouteFunc(c)