Documentation ¶
Index ¶
- Constants
- Variables
- func Decode(contentType string, data []byte, result interface{}) error
- func DecodeUrlValues(values url.Values, result interface{}) error
- func Encode(contentType string, data interface{}) ([]byte, error)
- func EncodeUrlValues(data interface{}) (url.Values, error)
- func Get(url string, result interface{}, opts ...Option) (*http.Response, error)
- func ParseContentType(content string) (string, string)
- func Post(url string, req interface{}, result interface{}, opts ...Option) (*http.Response, error)
- func PostForm(url string, req interface{}, result interface{}, opts ...Option) (*http.Response, error)
- type BindUnmarshaler
- type Binder
- type Client
- type Context
- type DefaultBinder
- type ErrorHandler
- type Group
- func (g *Group) Add(method, path string, handler HandlerFunc, middleware ...MiddlewareFunc) *Route
- func (g *Group) Any(path string, handler HandlerFunc, middleware ...MiddlewareFunc) []*Route
- func (g *Group) CONNECT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (g *Group) DELETE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (g *Group) File(path, file string)
- func (g *Group) GET(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (g *Group) Group(prefix string, middleware ...MiddlewareFunc) (sg *Group)
- func (g *Group) HEAD(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (g *Group) Match(methods []string, path string, handler HandlerFunc, ...) []*Route
- func (g *Group) OPTIONS(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (g *Group) PATCH(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (g *Group) POST(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (g *Group) PUT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (g *Group) Static(prefix, root string)
- func (g *Group) TRACE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (g *Group) Use(middleware ...MiddlewareFunc)
- type HTTPError
- type HandlerFunc
- type IBackOff
- type Map
- type MiddlewareFunc
- type Option
- func BackOff(b IBackOff) Option
- func Charset(x string) Option
- func ContentType(t string) Option
- func Header(header http.Header) Option
- func HeaderKV(key, value string) Option
- func HeaderMap(header map[string]string) Option
- func Query(q url.Values) Option
- func QueryKV(key, value string) Option
- func QueryMap(m map[string]string) Option
- func Retry(count int, cb RetryFunc) Option
- func Timeout(t time.Duration) Option
- type Options
- type Renderer
- type Response
- type RetryFunc
- type Route
- type Router
- type Server
- func (e *Server) AcquireContext() Context
- func (e *Server) Add(method, path string, handler HandlerFunc, middleware ...MiddlewareFunc) *Route
- func (e *Server) Any(path string, handler HandlerFunc, middleware ...MiddlewareFunc) []*Route
- func (e *Server) CONNECT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (e *Server) Close() error
- func (e *Server) DELETE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (e *Server) DefaultHTTPErrorHandler(err error, c Context)
- func (e *Server) File(path, file string, m ...MiddlewareFunc) *Route
- func (e *Server) GET(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (e *Server) Group(prefix string, m ...MiddlewareFunc) (g *Group)
- func (e *Server) HEAD(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (e *Server) Host(name string, m ...MiddlewareFunc) (g *Group)
- func (e *Server) Match(methods []string, path string, handler HandlerFunc, ...) []*Route
- func (e *Server) NewContext(r *http.Request, w http.ResponseWriter) Context
- func (e *Server) OPTIONS(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (e *Server) PATCH(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (e *Server) POST(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (e *Server) PUT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (e *Server) ReleaseContext(c Context)
- func (e *Server) Reverse(name string, params ...interface{}) string
- func (e *Server) Router() *Router
- func (e *Server) Routers() map[string]*Router
- func (e *Server) Routes() []*Route
- func (e *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
- func (e *Server) Shutdown(ctx context.Context) error
- func (e *Server) Start(address string) error
- func (e *Server) StartAutoTLS(address string) error
- func (e *Server) StartServer(s *http.Server) (err error)
- func (e *Server) StartTLS(address string, certFile, keyFile interface{}) (err error)
- func (e *Server) Static(prefix, root string) *Route
- func (e *Server) TRACE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
- func (e *Server) URI(handler HandlerFunc, params ...interface{}) string
- func (e *Server) URL(h HandlerFunc, params ...interface{}) string
- func (e *Server) Use(middleware ...MiddlewareFunc)
- type Validator
Constants ¶
const ( TypeJSON = "application/json" TypeXML = "application/xml" TypeForm = "application/x-www-form-urlencoded" TypeHTML = "text/html" TypeText = "text/plain" )
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" )
MIME types
const ( // 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 REPORT = "REPORT" )
const ( HeaderAccept = "Accept" HeaderAcceptEncoding = "Accept-Encoding" 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" 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" HeaderXRequestedWith = "X-Requested-With" HeaderServer = "Server" HeaderOrigin = "Origin" // Access control 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" // Security 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" )
Headers
const (
UTF8 = "utf-8"
)
Variables ¶
var ( ErrNoData = errors.New("no data") ErrNotSupport = errors.New("not support") ErrInvalidType = errors.New("invalid type") )
var ( ErrUnsupportedMediaType = NewHTTPError(http.StatusUnsupportedMediaType) ErrNotFound = NewHTTPError(http.StatusNotFound) ErrForbidden = NewHTTPError(http.StatusForbidden) ErrMethodNotAllowed = NewHTTPError(http.StatusMethodNotAllowed) ErrStatusRequestEntityTooLarge = NewHTTPError(http.StatusRequestEntityTooLarge) ErrTooManyRequests = NewHTTPError(http.StatusTooManyRequests) ErrBadRequest = NewHTTPError(http.StatusBadRequest) ErrBadGateway = NewHTTPError(http.StatusBadGateway) ErrInternalServerError = NewHTTPError(http.StatusInternalServerError) ErrRequestTimeout = NewHTTPError(http.StatusRequestTimeout) 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") )
Errors
var MethodNotAllowedHandler = func(c Context) error { return ErrMethodNotAllowed }
var NotFoundHandler = func(c Context) error { return ErrNotFound }
Error handlers
Functions ¶
func DecodeUrlValues ¶
func EncodeUrlValues ¶
convert map[string]string to url.Values
func ParseContentType ¶
Types ¶
type BindUnmarshaler ¶
type BindUnmarshaler interface { // UnmarshalParam decodes and assigns a value from an form or query param. UnmarshalParam(param string) error }
BindUnmarshaler is the interface used to wrap the UnmarshalParam method. Types that don't implement this, but do implement encoding.TextUnmarshaler will use that interface instead.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
简单封装标准HttpClient 支持根据ContentType自动编码和解码 支持重试,超时 支持添加Header,Query参数 其他一些参考: https://github.com/hashicorp/go-retryablehttp https://github.com/parnurzeal/gorequest
type Context ¶
type Context interface { // Reset resets the context after request completes. It must be called along // with `Echo#AcquireContext()` and `Echo#ReleaseContext()`. // See `Echo#ServeHTTP()` Reset(r *http.Request, w http.ResponseWriter) // Request returns `*http.Request`. Request() *http.Request // SetRequest sets `*http.Request`. SetRequest(r *http.Request) // Response returns `*Response`. Response() *Response // IsTLS returns true if HTTP connection is TLS otherwise false. IsTLS() bool // IsWebSocket returns true if HTTP connection is WebSocket otherwise false. IsWebSocket() bool // Scheme returns the HTTP protocol scheme, `http` or `https`. Scheme() string // RealIP returns the client's network address based on `X-Forwarded-For` // or `X-Real-IP` request header. RealIP() string // Path returns the registered path for the handler. Path() string // SetPath sets the registered path for the handler. SetPath(p string) // Param returns path parameter by name. Param(name string) string // ParamNames returns path parameter names. ParamNames() []string // SetParamNames sets path parameter names. SetParamNames(names ...string) // ParamValues returns path parameter values. ParamValues() []string // SetParamValues sets path parameter values. SetParamValues(values ...string) // QueryParam returns the query param for the provided name. QueryParam(name string) string // QueryParams returns the query parameters as `url.Values`. QueryParams() url.Values // QueryString returns the URL query string. QueryString() string // FormValue returns the form field value for the provided name. FormValue(name string) string // FormParams returns the form parameters as `url.Values`. FormParams() (url.Values, error) // FormFile returns the multipart form file for the provided name. FormFile(name string) (*multipart.FileHeader, error) // MultipartForm returns the multipart form. MultipartForm() (*multipart.Form, error) // Cookie returns the named cookie provided in the request. Cookie(name string) (*http.Cookie, error) // SetCookie adds a `Set-Cookie` header in HTTP response. SetCookie(cookie *http.Cookie) // Cookies returns the HTTP cookies sent with the request. Cookies() []*http.Cookie // Get retrieves data from the context. Get(key string) interface{} // Set saves data in the context. Set(key string, val interface{}) // Bind binds the request body into provided type `i`. The default binder // does it based on Content-Type header. Bind(i interface{}) error // Validate validates provided `i`. It is usually called after `Context#Bind()`. // Validator must be registered using `Echo#Validator`. Validate(i interface{}) error // Render renders a template with data and sends a text/html response with status // code. Renderer must be registered using `Echo.Renderer`. Render(code int, name string, data interface{}) error // HTML sends an HTTP response with status code. HTML(code int, html string) error // HTMLBlob sends an HTTP blob response with status code. HTMLBlob(code int, b []byte) error // String sends a string response with status code. String(code int, s string) error // JSON sends a JSON response with status code. JSON(code int, i interface{}) error // JSONPretty sends a pretty-print JSON with status code. JSONPretty(code int, i interface{}, indent string) error // JSONBlob sends a JSON blob response with status code. JSONBlob(code int, b []byte) error // JSONP sends a JSONP response with status code. It uses `callback` to construct // the JSONP payload. JSONP(code int, callback string, i interface{}) error // JSONPBlob sends a JSONP blob response with status code. It uses `callback` // to construct the JSONP payload. JSONPBlob(code int, callback string, b []byte) error // XML sends an XML response with status code. XML(code int, i interface{}) error // XMLPretty sends a pretty-print XML with status code. XMLPretty(code int, i interface{}, indent string) error // XMLBlob sends an XML blob response with status code. XMLBlob(code int, b []byte) error // Blob sends a blob response with status code and content type. Blob(code int, contentType string, b []byte) error // Stream sends a streaming response with status code and content type. Stream(code int, contentType string, r io.Reader) error // File sends a response with the content of the file. File(file string) error // Attachment sends a response as attachment, prompting client to save the // file. Attachment(file string, name string) error // Inline sends a response as inline, opening the file in the browser. Inline(file string, name string) error // NoContent sends a response with no body and a status code. NoContent(code int) error // Redirect redirects the request to a provided URL with status code. Redirect(code int, url string) error // Error invokes the registered HTTP error handler. Generally used by middleware. Error(err error) // Handler returns the matched handler by router. Handler() HandlerFunc // SetHandler sets the matched handler by router. SetHandler(h HandlerFunc) // Server returns the `Server` instance. Server() *Server }
Context represents the context of the current HTTP request. It holds request and response objects, path, path parameters, data and registered handler.
type DefaultBinder ¶
type DefaultBinder struct{}
DefaultBinder is the default implementation of the Binder interface.
func (*DefaultBinder) Bind ¶
func (b *DefaultBinder) Bind(i interface{}, c Context) (err error)
Bind implements the `Binder#Bind` function.
type ErrorHandler ¶
ErrorHandler is a centralized HTTP error handler.
type Group ¶
type Group struct {
// contains filtered or unexported fields
}
Group is a set of sub-routes for a specified route. It can be used for inner routes that share a common middleware or functionality that should be separate from the parent echo instance while still inheriting from it.
func (*Group) Add ¶
func (g *Group) Add(method, path string, handler HandlerFunc, middleware ...MiddlewareFunc) *Route
Add implements `Echo#Add()` for sub-routes within the Group.
func (*Group) Any ¶
func (g *Group) Any(path string, handler HandlerFunc, middleware ...MiddlewareFunc) []*Route
Any implements `Echo#Any()` for sub-routes within the Group.
func (*Group) CONNECT ¶
func (g *Group) CONNECT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
CONNECT implements `Echo#CONNECT()` for sub-routes within the Group.
func (*Group) DELETE ¶
func (g *Group) DELETE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
DELETE implements `Echo#DELETE()` for sub-routes within the Group.
func (*Group) GET ¶
func (g *Group) GET(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
GET implements `Echo#GET()` for sub-routes within the Group.
func (*Group) Group ¶
func (g *Group) Group(prefix string, middleware ...MiddlewareFunc) (sg *Group)
Group creates a new sub-group with prefix and optional sub-group-level middleware.
func (*Group) HEAD ¶
func (g *Group) HEAD(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
HEAD implements `Echo#HEAD()` for sub-routes within the Group.
func (*Group) Match ¶
func (g *Group) Match(methods []string, path string, handler HandlerFunc, middleware ...MiddlewareFunc) []*Route
Match implements `Echo#Match()` for sub-routes within the Group.
func (*Group) OPTIONS ¶
func (g *Group) OPTIONS(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
OPTIONS implements `Echo#OPTIONS()` for sub-routes within the Group.
func (*Group) PATCH ¶
func (g *Group) PATCH(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
PATCH implements `Echo#PATCH()` for sub-routes within the Group.
func (*Group) POST ¶
func (g *Group) POST(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
POST implements `Echo#POST()` for sub-routes within the Group.
func (*Group) PUT ¶
func (g *Group) PUT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
PUT implements `Echo#PUT()` for sub-routes within the Group.
func (*Group) TRACE ¶
func (g *Group) TRACE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
TRACE implements `Echo#TRACE()` for sub-routes within the Group.
func (*Group) Use ¶
func (g *Group) Use(middleware ...MiddlewareFunc)
Use implements `Echo#Use()` for sub-routes within the Group.
type HTTPError ¶
type HTTPError struct { Code int Message interface{} Internal error // Stores the error returned by an external dependency }
HTTPError represents an error that occurred while handling a request.
func NewHTTPError ¶
NewHTTPError creates a new HTTPError instance.
func (*HTTPError) SetInternal ¶
SetInternal sets error to HTTPError.Internal
type HandlerFunc ¶
HandlerFunc defines a function to serve HTTP requests.
type Map ¶
type Map map[string]interface{}
Map defines a generic map of type `map[string]interface{}`.
type MiddlewareFunc ¶
type MiddlewareFunc func(HandlerFunc) HandlerFunc
MiddlewareFunc defines a function to process middleware.
type Options ¶
type Options struct { Context context.Context // Timeout time.Duration // 超时时间 Retry int // 重试次数 RetryHook RetryFunc // 校验是否需要继续Retry BackOff IBackOff // 每次timeout后等待时间,nil不等待 ContentType string // 编码格式 Charset string // 编码格式,utf-8,GBK Header http.Header // 消息头 Query url.Values // 查询参数 // contains filtered or unexported fields }
func (*Options) ContentTypeWithCharset ¶
type Response ¶
type Response struct { Writer http.ResponseWriter Status int Size int64 Committed bool // contains filtered or unexported fields }
Response wraps an http.ResponseWriter and implements its interface to be used by an HTTP handler to construct an HTTP response. See: https://golang.org/pkg/net/http/#ResponseWriter
func NewResponse ¶
func NewResponse(w http.ResponseWriter, e *Server) (r *Response)
NewResponse creates a new instance of Response.
func (*Response) After ¶
func (r *Response) After(fn func())
After registers a function which is called just after the response is written. If the `Content-Length` is unknown, none of the after function is executed.
func (*Response) Before ¶
func (r *Response) Before(fn func())
Before registers a function which is called just before the response is written.
func (*Response) Flush ¶
func (r *Response) Flush()
Flush implements the http.Flusher interface to allow an HTTP handler to flush buffered data to the client. See http.Flusher(https://golang.org/pkg/net/http/#Flusher)
func (*Response) Header ¶
Header returns the header map for the writer that will be sent by WriteHeader. Changing the header after a call to WriteHeader (or Write) has no effect unless the modified headers were declared as trailers by setting the "Trailer" header before the call to WriteHeader (see example) To suppress implicit response headers, set their value to nil. Example: https://golang.org/pkg/net/http/#example_ResponseWriter_trailers
func (*Response) Hijack ¶
Hijack implements the http.Hijacker interface to allow an HTTP handler to take over the connection. See http.Hijacker(https://golang.org/pkg/net/http/#Hijacker)
func (*Response) WriteHeader ¶
WriteHeader sends an HTTP response header with status code. If WriteHeader is not called explicitly, the first call to Write will trigger an implicit WriteHeader(http.StatusOK). Thus explicit calls to WriteHeader are mainly used to send error codes.
type Router ¶
type Router struct {
// contains filtered or unexported fields
}
Router is the registry of all registered routes for an `Echo` instance for request matching and URL path parameter parsing.
func (*Router) Add ¶
func (r *Router) Add(method, path string, h HandlerFunc)
Add registers a new route for method and path with matching handler.
type Server ¶
type Server struct { Server *http.Server TLSServer *http.Server Listener net.Listener TLSListener net.Listener DisableHTTP2 bool Debug bool ErrorHandler ErrorHandler Binder Binder Validator Validator Renderer Renderer // contains filtered or unexported fields }
func (*Server) AcquireContext ¶
AcquireContext returns an empty `Context` instance from the pool. You must return the context by calling `ReleaseContext()`.
func (*Server) Add ¶
func (e *Server) Add(method, path string, handler HandlerFunc, middleware ...MiddlewareFunc) *Route
Add registers a new route for an HTTP method and path with matching handler in the router with optional route-level middleware.
func (*Server) Any ¶
func (e *Server) Any(path string, handler HandlerFunc, middleware ...MiddlewareFunc) []*Route
Any registers a new route for all HTTP methods and path with matching handler in the router with optional route-level middleware.
func (*Server) CONNECT ¶
func (e *Server) CONNECT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
CONNECT registers a new CONNECT route for a path with matching handler in the router with optional route-level middleware.
func (*Server) Close ¶
Close immediately stops the server. It internally calls `http.Server#Close()`.
func (*Server) DELETE ¶
func (e *Server) DELETE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
DELETE registers a new DELETE route for a path with matching handler in the router with optional route-level middleware.
func (*Server) DefaultHTTPErrorHandler ¶
DefaultHTTPErrorHandler is the default HTTP error handler. It sends a JSON response with status code.
func (*Server) File ¶
func (e *Server) File(path, file string, m ...MiddlewareFunc) *Route
File registers a new route with path to serve a static file with optional route-level middleware.
func (*Server) GET ¶
func (e *Server) GET(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
GET registers a new GET route for a path with matching handler in the router with optional route-level middleware.
func (*Server) Group ¶
func (e *Server) Group(prefix string, m ...MiddlewareFunc) (g *Group)
Group creates a new router group with prefix and optional group-level middleware.
func (*Server) HEAD ¶
func (e *Server) HEAD(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
HEAD registers a new HEAD route for a path with matching handler in the router with optional route-level middleware.
func (*Server) Host ¶
func (e *Server) Host(name string, m ...MiddlewareFunc) (g *Group)
Host creates a new router group for the provided host and optional host-level middleware.
func (*Server) Match ¶
func (e *Server) Match(methods []string, path string, handler HandlerFunc, middleware ...MiddlewareFunc) []*Route
Match registers a new route for multiple HTTP methods and path with matching handler in the router with optional route-level middleware.
func (*Server) NewContext ¶
NewContext returns a Context instance.
func (*Server) OPTIONS ¶
func (e *Server) OPTIONS(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
OPTIONS registers a new OPTIONS route for a path with matching handler in the router with optional route-level middleware.
func (*Server) PATCH ¶
func (e *Server) PATCH(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
PATCH registers a new PATCH route for a path with matching handler in the router with optional route-level middleware.
func (*Server) POST ¶
func (e *Server) POST(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
POST registers a new POST route for a path with matching handler in the router with optional route-level middleware.
func (*Server) PUT ¶
func (e *Server) PUT(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
PUT registers a new PUT route for a path with matching handler in the router with optional route-level middleware.
func (*Server) ReleaseContext ¶
ReleaseContext returns the `Context` instance back to the pool. You must call it after `AcquireContext()`.
func (*Server) ServeHTTP ¶
func (e *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
ServeHTTP implements `http.Handler` interface, which serves HTTP requests.
func (*Server) Shutdown ¶
Shutdown stops the server gracefully. It internally calls `http.Server#Shutdown()`.
func (*Server) StartAutoTLS ¶
StartAutoTLS starts an HTTPS server using certificates automatically installed from https://letsencrypt.org.
func (*Server) StartServer ¶
StartServer starts a custom http server.
func (*Server) StartTLS ¶
StartTLS starts an HTTPS server. If `certFile` or `keyFile` is `string` the values are treated as file paths. If `certFile` or `keyFile` is `[]byte` the values are treated as the certificate or key as-is.
func (*Server) Static ¶
Static registers a new route with path prefix to serve static files from the provided root directory.
func (*Server) TRACE ¶
func (e *Server) TRACE(path string, h HandlerFunc, m ...MiddlewareFunc) *Route
TRACE registers a new TRACE route for a path with matching handler in the router with optional route-level middleware.
func (*Server) URI ¶
func (e *Server) URI(handler HandlerFunc, params ...interface{}) string
URI generates a URI from handler.
func (*Server) URL ¶
func (e *Server) URL(h HandlerFunc, params ...interface{}) string
URL is an alias for `URI` function.
func (*Server) Use ¶
func (e *Server) Use(middleware ...MiddlewareFunc)
Use adds middleware to the chain which is run after router.