Interface Context

Attachment sends a response as attachment, prompting client to save the file.

Bind binds path params, query params and the request body into provided type i. The default binder binds body based on Content-Type header.

Blob sends a blob response with status code and content type.

Cookie returns the named cookie provided in the request.

Cookies returns the HTTP cookies sent with the request.

Echo returns the Echo instance.

WARNING: Remember that Echo public fields and methods are coroutine safe ONLY when you are NOT mutating them anywhere in your code after Echo server has started.

Error invokes the registered global HTTP error handler. Generally used by middleware. A side-effect of calling global error handler is that now Response has been committed (sent to the client) and middlewares up in chain can not change Response status code or Response body anymore.

Avoid using this method in handlers as no middleware will be able to effectively handle errors after that. Instead of calling this method in handler return your error and let it be handled by middlewares or global error handler.

File sends a response with the content of the file.

FileFS sends a response with the content of the file from given filesystem.

FormFile returns the multipart form file for the provided name.

FormValue returns the form field value for the provided name.

FormValueDefault returns the form field value or default value for the provided name.

FormValues returns the form field values as url.Values.

Get retrieves data from the context.

HTML sends an HTTP response with status code.

HTMLBlob sends an HTTP blob response with status code.

Inline sends a response as inline, opening the file in the browser.

IsTLS returns true if HTTP connection is TLS otherwise false.

IsWebSocket returns true if HTTP connection is WebSocket otherwise false.

JSON sends a JSON response with status code.

JSONBlob sends a JSON blob response with status code.

JSONPretty sends a pretty-print JSON with status code.

JSONP sends a JSONP response with status code. It uses callback to construct the JSONP payload.

JSONPBlob sends a JSONP blob response with status code. It uses callback to construct the JSONP payload.

MultipartForm returns the multipart form.

NoContent sends a response with no body and a status code.

Path returns the registered path for the handler.

PathParam returns path parameter by name.

PathParamDefault returns the path parameter or default value for the provided name.

Notes for DefaultRouter implementation: Path parameter could be empty for cases like that:

• route /release-:version/bin and request URL is /release-/bin
• route /api/:version/image.jpg and request URL is /api//image.jpg but not when path parameter is last part of route path
• route /download/file.:ext will not match request /download/file.

PathParams returns path parameter values.

QueryParam returns the query param for the provided name.

QueryParamDefault returns the query param or default value for the provided name.

QueryParams returns the query parameters as url.Values.

QueryString returns the URL query string.

RealIP returns the client's network address based on X-Forwarded-For or X-Real-IP request header. The behavior can be configured using Echo#IPExtractor.

Redirect redirects the request to a provided URL with status code.

Render renders a template with data and sends a text/html response with status code. Renderer must be registered using Echo.Renderer.

Request returns *http.Request.

Response returns *Response.

RouteInfo returns current request route information. Method, Path, Name and params if they exist for matched route. In case of 404 (route not found) and 405 (method not allowed) RouteInfo returns generic struct for these cases.

Scheme returns the HTTP protocol scheme, http or https.

Set saves data in the context.

SetCookie adds a Set-Cookie header in HTTP response.

SetPathParams sets path parameters for current request.

SetRequest sets *http.Request.

SetResponse sets *Response.

Stream sends a streaming response with status code and content type.

String sends a string response with status code.

Validate validates provided i. It is usually called after Context#Bind(). Validator must be registered using Echo#Validator.

XML sends an XML response with status code.

XMLBlob sends an XML blob response with status code.

XMLPretty sends a pretty-print XML with status code.