Documentation
¶
Index ¶
- Constants
- Variables
- func NewRouter(e *Echo) (r *router)
- type BindFunc
- type Context
- func (c *Context) Bind(i interface{}) *HTTPError
- func (c *Context) Error(he *HTTPError)
- func (c *Context) Get(key string) interface{}
- func (c *Context) HTML(code int, html string) *HTTPError
- func (c *Context) JSON(code int, i interface{}) *HTTPError
- func (c *Context) NoContent(code int) *HTTPError
- func (c *Context) P(i uint8) (value string)
- func (c *Context) Param(name string) (value string)
- func (c *Context) Redirect(code int, url string)
- func (c *Context) Render(code int, name string, data interface{}) *HTTPError
- func (c *Context) Set(key string, val interface{})
- func (c *Context) String(code int, s string) *HTTPError
- type Echo
- func (e *Echo) Binder(b BindFunc)
- func (e *Echo) Connect(path string, h Handler)
- func (e *Echo) Debug(on bool)
- func (e *Echo) Delete(path string, h Handler)
- func (e *Echo) Favicon(file string)
- func (e *Echo) Get(path string, h Handler)
- func (e *Echo) Group(pfx string, m ...Middleware) *Echo
- func (e *Echo) HTTPErrorHandler(h HTTPErrorHandler)
- func (e *Echo) Head(path string, h Handler)
- func (e *Echo) Index(file string)
- func (e *Echo) MaxParam(n uint8)
- func (e *Echo) Options(path string, h Handler)
- func (e *Echo) Patch(path string, h Handler)
- func (e *Echo) Post(path string, h Handler)
- func (e *Echo) Put(path string, h Handler)
- func (e *Echo) Renderer(r Renderer)
- func (e *Echo) Run(addr string)
- func (e *Echo) RunServer(server *http.Server)
- func (e *Echo) RunTLS(addr, certFile, keyFile string)
- func (e *Echo) RunTLSServer(server *http.Server, certFile, keyFile string)
- func (e *Echo) ServeFile(path, file string)
- func (e *Echo) ServeHTTP(w http.ResponseWriter, r *http.Request)
- func (e *Echo) Static(path, root string)
- func (e *Echo) Trace(path string, h Handler)
- func (e *Echo) URI(h Handler, params ...interface{}) string
- func (e *Echo) URL(h Handler, params ...interface{}) string
- func (e *Echo) Use(m ...Middleware)
- type HTTPError
- type HTTPErrorHandler
- type Handler
- type HandlerFunc
- type Middleware
- type MiddlewareFunc
- type Renderer
- type Response
- func (r *Response) CloseNotify() <-chan bool
- func (r *Response) Flush()
- func (r *Response) Header() http.Header
- func (r *Response) Hijack() (net.Conn, *bufio.ReadWriter, error)
- func (r *Response) Size() int64
- func (r *Response) Status() int
- func (r *Response) Write(b []byte) (n int, err error)
- func (r *Response) WriteHeader(code int)
Constants ¶
const ( // CONNECT HTTP method CONNECT = "CONNECT" // DELETE HTTP method DELETE = "DELETE" // GET HTTP method GET = "GET" // HEAD HTTP method HEAD = "HEAD" // OPTIONS HTTP method OPTIONS = "OPTIONS" // PATCH HTTP method PATCH = "PATCH" // POST HTTP method POST = "POST" // PUT HTTP method PUT = "PUT" // TRACE HTTP method TRACE = "TRACE" ApplicationJSON = "application/json" ApplicationProtobuf = "application/protobuf" ApplicationMsgpack = "application/msgpack" TextPlain = "text/plain" TextHTML = "text/html" ApplicationForm = "application/x-www-form-urlencoded" MultipartForm = "multipart/form-data" Accept = "Accept" AcceptEncoding = "Accept-Encoding" ContentDisposition = "Content-Disposition" ContentEncoding = "Content-Encoding" ContentLength = "Content-Length" ContentType = "Content-Type" Authorization = "Authorization" )
Variables ¶
Functions ¶
Types ¶
type Context ¶
type Context struct { Request *http.Request Response *Response // contains filtered or unexported fields }
Context represents context for the current request. It holds request and response objects, path parameters, data and registered handler.
func NewContext ¶ added in v0.0.13
func (*Context) Bind ¶
Bind binds the request body into specified type v. Default binder does it based on Content-Type header.
func (*Context) Error ¶ added in v0.0.10
Error invokes the registered HTTP error handler.
func (*Context) Get ¶
Get retrieves data from the context.
func (*Context) HTML ¶ added in v0.0.5
HTML sends a text/html response with status code.
func (*Context) JSON ¶
JSON sends an application/json response with status code.
func (*Context) NoContent ¶ added in v0.0.10
NoContent sends a response with no body and a status code.
func (*Context) Param ¶
Param returns path parameter by name.
func (*Context) Redirect ¶
Redirect redirects the request using http.Redirect with status code.
func (*Context) Render ¶ added in v0.0.5
Render invokes the registered HTML template renderer and sends a text/html response with status code.
func (*Context) Set ¶
Set saves data in the context.
type Echo ¶
type Echo struct { Router *router // contains filtered or unexported fields }
func (*Echo) Binder ¶ added in v0.0.9
Binder registers a custom binder. It's invoked by Context.Bind API.
func (*Echo) Connect ¶
Connect adds a CONNECT route > handler to the router.
func (*Echo) Debug ¶ added in v0.0.13
Debug runs the application in debug mode.
func (*Echo) Delete ¶
Delete adds a DELETE route > handler to the router.
func (*Echo) Favicon ¶ added in v0.0.13
Favicon serves the default favicon - GET /favicon.ico.
func (*Echo) Get ¶
Get adds a GET route > handler to the router.
func (*Echo) Group ¶ added in v0.0.4
func (e *Echo) Group(pfx string, m ...Middleware) *Echo
Group creates a new sub router with prefix. It inherits all properties from the parent. Passing middleware overrides parent middleware.
func (*Echo) HTTPErrorHandler ¶ added in v0.0.10
func (e *Echo) HTTPErrorHandler(h HTTPErrorHandler)
HTTPErrorHandler registers an HTTP error handler.
func (*Echo) Head ¶
Head adds a HEAD route > handler to the router.
func (*Echo) MaxParam ¶
MaxParam sets the maximum number of path parameters allowed for the application. Default value is 5, good enough for many use cases.
func (*Echo) Options ¶
Options adds an OPTIONS route > handler to the router.
func (*Echo) Patch ¶
Patch adds a PATCH route > handler to the router.
func (*Echo) Post ¶
Post adds a POST route > handler to the router.
func (*Echo) Put ¶
Put adds a PUT route > handler to the router.
func (*Echo) Renderer ¶ added in v0.0.7
Renderer registers an HTML template renderer. It's invoked by Context.Render API.
func (*Echo) RunServer ¶ added in v0.0.5
RunServer runs a custom server.
func (*Echo) RunTLS ¶ added in v0.0.5
RunTLS runs a server with TLS configuration.
func (*Echo) RunTLSServer ¶ added in v0.0.5
RunTLSServer runs a custom server with TLS configuration.
func (*Echo) Trace ¶
Trace adds a TRACE route > handler to the router.
func (*Echo) URI ¶ added in v0.0.11
URI generates a URI from handler.
func (*Echo) URL ¶ added in v0.0.11
URL is an alias for URI
type HTTPErrorHandler ¶ added in v0.0.10
HTTPErrorHandler is a centralized HTTP error handler.
type Handler ¶
type Handler interface{}
type Middleware ¶
type Middleware interface{}
type MiddlewareFunc ¶
type MiddlewareFunc func(HandlerFunc) HandlerFunc
type Renderer ¶ added in v0.0.7
Renderer is the interface that wraps the Render method.
Render renders the HTML template with given name and specified data. It writes the output to w.
type Response ¶ added in v0.0.13
type Response struct { Writer http.ResponseWriter // contains filtered or unexported fields }
func (*Response) CloseNotify ¶ added in v0.0.13
CloseNotify wraps response writer's CloseNotify function.
func (*Response) Flush ¶ added in v0.0.13
func (r *Response) Flush()
Flush wraps response writer's Flush function.
func (*Response) Hijack ¶ added in v0.0.13
Hijack wraps response writer's Hijack function.
Source Files
¶
- context.go
- echo.go
- response.go
- router.go