fiber

package module
v2.52.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 5, 2024 License: MIT Imports: 42 Imported by: 21,676

Documentation

Overview

Package fiber is an Express inspired web framework built on top of Fasthttp, the fastest HTTP engine for Go. Designed to ease things up for fast development with zero memory allocation and performance in mind.

Index

Constants

View Source 
const (
	DefaultBodyLimit            = 4 * 1024 * 1024
	DefaultConcurrency          = 256 * 1024
	DefaultReadBufferSize       = 4096
	DefaultWriteBufferSize      = 4096
	DefaultCompressedFileSuffix = ".fiber.gz"
)

Default Config values

View Source 
const (
	MethodGet     = "GET"     // RFC 7231, 4.3.1
	MethodHead    = "HEAD"    // RFC 7231, 4.3.2
	MethodPost    = "POST"    // RFC 7231, 4.3.3
	MethodPut     = "PUT"     // RFC 7231, 4.3.4
	MethodPatch   = "PATCH"   // RFC 5789
	MethodDelete  = "DELETE"  // RFC 7231, 4.3.5
	MethodConnect = "CONNECT" // RFC 7231, 4.3.6
	MethodOptions = "OPTIONS" // RFC 7231, 4.3.7
	MethodTrace   = "TRACE"   // RFC 7231, 4.3.8

)

HTTP methods were copied from net/http.

View Source 
const (
	MIMETextXML         = "text/xml"
	MIMETextHTML        = "text/html"
	MIMETextPlain       = "text/plain"
	MIMETextJavaScript  = "text/javascript"
	MIMEApplicationXML  = "application/xml"
	MIMEApplicationJSON = "application/json"
	// Deprecated: use MIMETextJavaScript instead
	MIMEApplicationJavaScript = "application/javascript"
	MIMEApplicationForm       = "application/x-www-form-urlencoded"
	MIMEOctetStream           = "application/octet-stream"
	MIMEMultipartForm         = "multipart/form-data"

	MIMETextXMLCharsetUTF8         = "text/xml; charset=utf-8"
	MIMETextHTMLCharsetUTF8        = "text/html; charset=utf-8"
	MIMETextPlainCharsetUTF8       = "text/plain; charset=utf-8"
	MIMETextJavaScriptCharsetUTF8  = "text/javascript; charset=utf-8"
	MIMEApplicationXMLCharsetUTF8  = "application/xml; charset=utf-8"
	MIMEApplicationJSONCharsetUTF8 = "application/json; charset=utf-8"
	// Deprecated: use MIMETextJavaScriptCharsetUTF8 instead
	MIMEApplicationJavaScriptCharsetUTF8 = "application/javascript; charset=utf-8"
)

MIME types that are commonly used

View Source 
const (
	StatusContinue           = 100 // RFC 9110, 15.2.1
	StatusSwitchingProtocols = 101 // RFC 9110, 15.2.2
	StatusProcessing         = 102 // RFC 2518, 10.1
	StatusEarlyHints         = 103 // RFC 8297

	StatusOK                          = 200 // RFC 9110, 15.3.1
	StatusCreated                     = 201 // RFC 9110, 15.3.2
	StatusAccepted                    = 202 // RFC 9110, 15.3.3
	StatusNonAuthoritativeInformation = 203 // RFC 9110, 15.3.4
	StatusNoContent                   = 204 // RFC 9110, 15.3.5
	StatusResetContent                = 205 // RFC 9110, 15.3.6
	StatusPartialContent              = 206 // RFC 9110, 15.3.7
	StatusMultiStatus                 = 207 // RFC 4918, 11.1
	StatusAlreadyReported             = 208 // RFC 5842, 7.1
	StatusIMUsed                      = 226 // RFC 3229, 10.4.1

	StatusMultipleChoices   = 300 // RFC 9110, 15.4.1
	StatusMovedPermanently  = 301 // RFC 9110, 15.4.2
	StatusFound             = 302 // RFC 9110, 15.4.3
	StatusSeeOther          = 303 // RFC 9110, 15.4.4
	StatusNotModified       = 304 // RFC 9110, 15.4.5
	StatusUseProxy          = 305 // RFC 9110, 15.4.6
	StatusSwitchProxy       = 306 // RFC 9110, 15.4.7 (Unused)
	StatusTemporaryRedirect = 307 // RFC 9110, 15.4.8
	StatusPermanentRedirect = 308 // RFC 9110, 15.4.9

	StatusBadRequest                   = 400 // RFC 9110, 15.5.1
	StatusUnauthorized                 = 401 // RFC 9110, 15.5.2
	StatusPaymentRequired              = 402 // RFC 9110, 15.5.3
	StatusForbidden                    = 403 // RFC 9110, 15.5.4
	StatusNotFound                     = 404 // RFC 9110, 15.5.5
	StatusMethodNotAllowed             = 405 // RFC 9110, 15.5.6
	StatusNotAcceptable                = 406 // RFC 9110, 15.5.7
	StatusProxyAuthRequired            = 407 // RFC 9110, 15.5.8
	StatusRequestTimeout               = 408 // RFC 9110, 15.5.9
	StatusConflict                     = 409 // RFC 9110, 15.5.10
	StatusGone                         = 410 // RFC 9110, 15.5.11
	StatusLengthRequired               = 411 // RFC 9110, 15.5.12
	StatusPreconditionFailed           = 412 // RFC 9110, 15.5.13
	StatusRequestEntityTooLarge        = 413 // RFC 9110, 15.5.14
	StatusRequestURITooLong            = 414 // RFC 9110, 15.5.15
	StatusUnsupportedMediaType         = 415 // RFC 9110, 15.5.16
	StatusRequestedRangeNotSatisfiable = 416 // RFC 9110, 15.5.17
	StatusExpectationFailed            = 417 // RFC 9110, 15.5.18
	StatusTeapot                       = 418 // RFC 9110, 15.5.19 (Unused)
	StatusMisdirectedRequest           = 421 // RFC 9110, 15.5.20
	StatusUnprocessableEntity          = 422 // RFC 9110, 15.5.21
	StatusLocked                       = 423 // RFC 4918, 11.3
	StatusFailedDependency             = 424 // RFC 4918, 11.4
	StatusTooEarly                     = 425 // RFC 8470, 5.2.
	StatusUpgradeRequired              = 426 // RFC 9110, 15.5.22
	StatusPreconditionRequired         = 428 // RFC 6585, 3
	StatusTooManyRequests              = 429 // RFC 6585, 4
	StatusRequestHeaderFieldsTooLarge  = 431 // RFC 6585, 5
	StatusUnavailableForLegalReasons   = 451 // RFC 7725, 3

	StatusInternalServerError           = 500 // RFC 9110, 15.6.1
	StatusNotImplemented                = 501 // RFC 9110, 15.6.2
	StatusBadGateway                    = 502 // RFC 9110, 15.6.3
	StatusServiceUnavailable            = 503 // RFC 9110, 15.6.4
	StatusGatewayTimeout                = 504 // RFC 9110, 15.6.5
	StatusHTTPVersionNotSupported       = 505 // RFC 9110, 15.6.6
	StatusVariantAlsoNegotiates         = 506 // RFC 2295, 8.1
	StatusInsufficientStorage           = 507 // RFC 4918, 11.5
	StatusLoopDetected                  = 508 // RFC 5842, 7.2
	StatusNotExtended                   = 510 // RFC 2774, 7
	StatusNetworkAuthenticationRequired = 511 // RFC 6585, 6
)

HTTP status codes were copied from net/http with the following updates: - Rename StatusNonAuthoritativeInfo to StatusNonAuthoritativeInformation - Add StatusSwitchProxy (306) NOTE: Keep this list in sync with statusMessage

View Source 
const (
	HeaderAuthorization                   = "Authorization"
	HeaderProxyAuthenticate               = "Proxy-Authenticate"
	HeaderProxyAuthorization              = "Proxy-Authorization"
	HeaderWWWAuthenticate                 = "WWW-Authenticate"
	HeaderAge                             = "Age"
	HeaderCacheControl                    = "Cache-Control"
	HeaderClearSiteData                   = "Clear-Site-Data"
	HeaderExpires                         = "Expires"
	HeaderPragma                          = "Pragma"
	HeaderWarning                         = "Warning"
	HeaderAcceptCH                        = "Accept-CH"
	HeaderAcceptCHLifetime                = "Accept-CH-Lifetime"
	HeaderContentDPR                      = "Content-DPR"
	HeaderDPR                             = "DPR"
	HeaderEarlyData                       = "Early-Data"
	HeaderSaveData                        = "Save-Data"
	HeaderViewportWidth                   = "Viewport-Width"
	HeaderWidth                           = "Width"
	HeaderETag                            = "ETag"
	HeaderIfMatch                         = "If-Match"
	HeaderIfModifiedSince                 = "If-Modified-Since"
	HeaderIfNoneMatch                     = "If-None-Match"
	HeaderIfUnmodifiedSince               = "If-Unmodified-Since"
	HeaderLastModified                    = "Last-Modified"
	HeaderVary                            = "Vary"
	HeaderConnection                      = "Connection"
	HeaderKeepAlive                       = "Keep-Alive"
	HeaderAccept                          = "Accept"
	HeaderAcceptCharset                   = "Accept-Charset"
	HeaderAcceptEncoding                  = "Accept-Encoding"
	HeaderAcceptLanguage                  = "Accept-Language"
	HeaderCookie                          = "Cookie"
	HeaderExpect                          = "Expect"
	HeaderMaxForwards                     = "Max-Forwards"
	HeaderSetCookie                       = "Set-Cookie"
	HeaderAccessControlAllowCredentials   = "Access-Control-Allow-Credentials"
	HeaderAccessControlAllowHeaders       = "Access-Control-Allow-Headers"
	HeaderAccessControlAllowMethods       = "Access-Control-Allow-Methods"
	HeaderAccessControlAllowOrigin        = "Access-Control-Allow-Origin"
	HeaderAccessControlExposeHeaders      = "Access-Control-Expose-Headers"
	HeaderAccessControlMaxAge             = "Access-Control-Max-Age"
	HeaderAccessControlRequestHeaders     = "Access-Control-Request-Headers"
	HeaderAccessControlRequestMethod      = "Access-Control-Request-Method"
	HeaderOrigin                          = "Origin"
	HeaderTimingAllowOrigin               = "Timing-Allow-Origin"
	HeaderXPermittedCrossDomainPolicies   = "X-Permitted-Cross-Domain-Policies"
	HeaderDNT                             = "DNT"
	HeaderTk                              = "Tk"
	HeaderContentDisposition              = "Content-Disposition"
	HeaderContentEncoding                 = "Content-Encoding"
	HeaderContentLanguage                 = "Content-Language"
	HeaderContentLength                   = "Content-Length"
	HeaderContentLocation                 = "Content-Location"
	HeaderContentType                     = "Content-Type"
	HeaderForwarded                       = "Forwarded"
	HeaderVia                             = "Via"
	HeaderXForwardedFor                   = "X-Forwarded-For"
	HeaderXForwardedHost                  = "X-Forwarded-Host"
	HeaderXForwardedProto                 = "X-Forwarded-Proto"
	HeaderXForwardedProtocol              = "X-Forwarded-Protocol"
	HeaderXForwardedSsl                   = "X-Forwarded-Ssl"
	HeaderXUrlScheme                      = "X-Url-Scheme"
	HeaderLocation                        = "Location"
	HeaderFrom                            = "From"
	HeaderHost                            = "Host"
	HeaderReferer                         = "Referer"
	HeaderReferrerPolicy                  = "Referrer-Policy"
	HeaderUserAgent                       = "User-Agent"
	HeaderAllow                           = "Allow"
	HeaderServer                          = "Server"
	HeaderAcceptRanges                    = "Accept-Ranges"
	HeaderContentRange                    = "Content-Range"
	HeaderIfRange                         = "If-Range"
	HeaderRange                           = "Range"
	HeaderContentSecurityPolicy           = "Content-Security-Policy"
	HeaderContentSecurityPolicyReportOnly = "Content-Security-Policy-Report-Only"
	HeaderCrossOriginResourcePolicy       = "Cross-Origin-Resource-Policy"
	HeaderExpectCT                        = "Expect-CT"
	// Deprecated: use HeaderPermissionsPolicy instead
	HeaderFeaturePolicy           = "Feature-Policy"
	HeaderPermissionsPolicy       = "Permissions-Policy"
	HeaderPublicKeyPins           = "Public-Key-Pins"
	HeaderPublicKeyPinsReportOnly = "Public-Key-Pins-Report-Only"
	HeaderStrictTransportSecurity = "Strict-Transport-Security"
	HeaderUpgradeInsecureRequests = "Upgrade-Insecure-Requests"
	HeaderXContentTypeOptions     = "X-Content-Type-Options"
	HeaderXDownloadOptions        = "X-Download-Options"
	HeaderXFrameOptions           = "X-Frame-Options"
	HeaderXPoweredBy              = "X-Powered-By"
	HeaderXXSSProtection          = "X-XSS-Protection"
	HeaderLastEventID             = "Last-Event-ID"
	HeaderNEL                     = "NEL"
	HeaderPingFrom                = "Ping-From"
	HeaderPingTo                  = "Ping-To"
	HeaderReportTo                = "Report-To"
	HeaderTE                      = "TE"
	HeaderTrailer                 = "Trailer"
	HeaderTransferEncoding        = "Transfer-Encoding"
	HeaderSecWebSocketAccept      = "Sec-WebSocket-Accept"
	HeaderSecWebSocketExtensions  = "Sec-WebSocket-Extensions"
	HeaderSecWebSocketKey         = "Sec-WebSocket-Key"
	HeaderSecWebSocketProtocol    = "Sec-WebSocket-Protocol"
	HeaderSecWebSocketVersion     = "Sec-WebSocket-Version"
	HeaderAcceptPatch             = "Accept-Patch"
	HeaderAcceptPushPolicy        = "Accept-Push-Policy"
	HeaderAcceptSignature         = "Accept-Signature"
	HeaderAltSvc                  = "Alt-Svc"
	HeaderDate                    = "Date"
	HeaderIndex                   = "Index"
	HeaderLargeAllocation         = "Large-Allocation"
	HeaderLink                    = "Link"
	HeaderPushPolicy              = "Push-Policy"
	HeaderRetryAfter              = "Retry-After"
	HeaderServerTiming            = "Server-Timing"
	HeaderSignature               = "Signature"
	HeaderSignedHeaders           = "Signed-Headers"
	HeaderSourceMap               = "SourceMap"
	HeaderUpgrade                 = "Upgrade"
	HeaderXDNSPrefetchControl     = "X-DNS-Prefetch-Control"
	HeaderXPingback               = "X-Pingback"
	HeaderXRequestID              = "X-Request-ID"
	HeaderXRequestedWith          = "X-Requested-With"
	HeaderXRobotsTag              = "X-Robots-Tag"
	HeaderXUACompatible           = "X-UA-Compatible"
)

HTTP Headers were copied from net/http.

View Source 
const (
	NetworkTCP  = "tcp"
	NetworkTCP4 = "tcp4"
	NetworkTCP6 = "tcp6"
)

Network types that are commonly used

View Source 
const (
	StrGzip    = "gzip"
	StrBr      = "br"
	StrDeflate = "deflate"
	StrBrotli  = "brotli"
)

Compression types

View Source 
const (
	CookieSameSiteDisabled   = "disabled" // not in RFC, just control "SameSite" attribute will not be set.
	CookieSameSiteLaxMode    = "lax"
	CookieSameSiteStrictMode = "strict"
	CookieSameSiteNoneMode   = "none"
)

Cookie SameSite https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7

View Source 
const (
	ConstraintInt             = "int"
	ConstraintBool            = "bool"
	ConstraintFloat           = "float"
	ConstraintAlpha           = "alpha"
	ConstraintGuid            = "guid" //nolint:revive,stylecheck // TODO: Rename to "ConstraintGUID" in v3
	ConstraintMinLen          = "minLen"
	ConstraintMaxLen          = "maxLen"
	ConstraintLen             = "len"
	ConstraintBetweenLen      = "betweenLen"
	ConstraintMinLenLower     = "minlen"
	ConstraintMaxLenLower     = "maxlen"
	ConstraintBetweenLenLower = "betweenlen"
	ConstraintMin             = "min"
	ConstraintMax             = "max"
	ConstraintRange           = "range"
	ConstraintDatetime        = "datetime"
	ConstraintRegex           = "regex"
)

Route Constraints

View Source 
const Version = "2.52.0"

Version of current fiber package

Variables

View Source 
var (
	ErrRangeMalformed     = errors.New("range: malformed range header string")
	ErrRangeUnsatisfiable = errors.New("range: unsatisfiable range")
)
View Source 
var (
	ErrBadRequest                   = NewError(StatusBadRequest)                   // 400
	ErrUnauthorized                 = NewError(StatusUnauthorized)                 // 401
	ErrPaymentRequired              = NewError(StatusPaymentRequired)              // 402
	ErrForbidden                    = NewError(StatusForbidden)                    // 403
	ErrNotFound                     = NewError(StatusNotFound)                     // 404
	ErrMethodNotAllowed             = NewError(StatusMethodNotAllowed)             // 405
	ErrNotAcceptable                = NewError(StatusNotAcceptable)                // 406
	ErrProxyAuthRequired            = NewError(StatusProxyAuthRequired)            // 407
	ErrRequestTimeout               = NewError(StatusRequestTimeout)               // 408
	ErrConflict                     = NewError(StatusConflict)                     // 409
	ErrGone                         = NewError(StatusGone)                         // 410
	ErrLengthRequired               = NewError(StatusLengthRequired)               // 411
	ErrPreconditionFailed           = NewError(StatusPreconditionFailed)           // 412
	ErrRequestEntityTooLarge        = NewError(StatusRequestEntityTooLarge)        // 413
	ErrRequestURITooLong            = NewError(StatusRequestURITooLong)            // 414
	ErrUnsupportedMediaType         = NewError(StatusUnsupportedMediaType)         // 415
	ErrRequestedRangeNotSatisfiable = NewError(StatusRequestedRangeNotSatisfiable) // 416
	ErrExpectationFailed            = NewError(StatusExpectationFailed)            // 417
	ErrTeapot                       = NewError(StatusTeapot)                       // 418
	ErrMisdirectedRequest           = NewError(StatusMisdirectedRequest)           // 421
	ErrUnprocessableEntity          = NewError(StatusUnprocessableEntity)          // 422
	ErrLocked                       = NewError(StatusLocked)                       // 423
	ErrFailedDependency             = NewError(StatusFailedDependency)             // 424
	ErrTooEarly                     = NewError(StatusTooEarly)                     // 425
	ErrUpgradeRequired              = NewError(StatusUpgradeRequired)              // 426
	ErrPreconditionRequired         = NewError(StatusPreconditionRequired)         // 428
	ErrTooManyRequests              = NewError(StatusTooManyRequests)              // 429
	ErrRequestHeaderFieldsTooLarge  = NewError(StatusRequestHeaderFieldsTooLarge)  // 431
	ErrUnavailableForLegalReasons   = NewError(StatusUnavailableForLegalReasons)   // 451

	ErrInternalServerError           = NewError(StatusInternalServerError)           // 500
	ErrNotImplemented                = NewError(StatusNotImplemented)                // 501
	ErrBadGateway                    = NewError(StatusBadGateway)                    // 502
	ErrServiceUnavailable            = NewError(StatusServiceUnavailable)            // 503
	ErrGatewayTimeout                = NewError(StatusGatewayTimeout)                // 504
	ErrHTTPVersionNotSupported       = NewError(StatusHTTPVersionNotSupported)       // 505
	ErrVariantAlsoNegotiates         = NewError(StatusVariantAlsoNegotiates)         // 506
	ErrInsufficientStorage           = NewError(StatusInsufficientStorage)           // 507
	ErrLoopDetected                  = NewError(StatusLoopDetected)                  // 508
	ErrNotExtended                   = NewError(StatusNotExtended)                   // 510
	ErrNetworkAuthenticationRequired = NewError(StatusNetworkAuthenticationRequired) // 511
)

Errors

View Source 
var DefaultColors = Colors{
	Black:   "\u001b[90m",
	Red:     "\u001b[91m",
	Green:   "\u001b[92m",
	Yellow:  "\u001b[93m",
	Blue:    "\u001b[94m",
	Magenta: "\u001b[95m",
	Cyan:    "\u001b[96m",
	White:   "\u001b[97m",
	Reset:   "\u001b[0m",
}

DefaultColors Default color codes

View Source 
var DefaultMethods = []string{
	MethodGet,
	MethodHead,
	MethodPost,
	MethodPut,
	MethodDelete,
	MethodConnect,
	MethodOptions,
	MethodTrace,
	MethodPatch,
}

HTTP methods enabled by default

Functions

func DefaultErrorHandler 

func DefaultErrorHandler(c *Ctx, err error) error

DefaultErrorHandler that process return errors from handlers

func GetTrimmedParam 

func GetTrimmedParam(param string) string

GetTrimmedParam trims the ':' & '?' from a string

func IndexRune added in v2.42.0 

func IndexRune(str string, needle int32) bool

func IsChild 

func IsChild() bool

IsChild determines if the current process is a child of Prefork

func IsMethodIdempotent added in v2.42.0 

func IsMethodIdempotent(m string) bool

IsMethodIdempotent reports whether the HTTP method is considered idempotent. See https://datatracker.ietf.org/doc/html/rfc9110#section-9.2.2

func IsMethodSafe added in v2.42.0 

func IsMethodSafe(m string) bool

IsMethodSafe reports whether the HTTP method is considered safe. See https://datatracker.ietf.org/doc/html/rfc9110#section-9.2.1

func ReleaseAgent added in v2.6.0 

func ReleaseAgent(a *Agent)

ReleaseAgent returns an acquired via AcquireAgent to Agent pool.

It is forbidden accessing req and/or it's members after returning it to Agent pool.

func ReleaseArgs added in v2.6.0 

func ReleaseArgs(a *Args)

ReleaseArgs returns the object acquired via AcquireArgs to the pool.

String not access the released Args object, otherwise data races may occur. Copy from fasthttp

func ReleaseClient added in v2.6.0 

func ReleaseClient(c *Client)

ReleaseClient returns c acquired via AcquireClient to client pool.

It is forbidden accessing req and/or it's members after returning it to client pool.

func ReleaseFormFile added in v2.6.0 

func ReleaseFormFile(ff *FormFile)

ReleaseFormFile returns the object acquired via AcquireFormFile to the pool.

String not access the released FormFile object, otherwise data races may occur.

func ReleaseResponse added in v2.6.0 

func ReleaseResponse(resp *Response)

ReleaseResponse return resp acquired via AcquireResponse to response pool.

It is forbidden accessing resp and/or it's members after returning it to response pool. Copy from fasthttp

func RemoveEscapeChar added in v2.8.0 

func RemoveEscapeChar(word string) string

RemoveEscapeChar remove escape characters

func RoutePatternMatch added in v2.41.0 

func RoutePatternMatch(path, pattern string, cfg ...Config) bool

RoutePatternMatch checks if a given path matches a Fiber route pattern.

func SetParserDecoder added in v2.20.0 

func SetParserDecoder(parserConfig ParserConfig)

SetParserDecoder allow globally change the option of form decoder, update decoderPool

Types

type Agent added in v2.6.0 

type Agent struct {
	// Name is used in User-Agent request header.
	Name string

	// NoDefaultUserAgentHeader when set to true, causes the default
	// User-Agent header to be excluded from the Request.
	NoDefaultUserAgentHeader bool

	// HostClient is an embedded fasthttp HostClient
	*fasthttp.HostClient
	// contains filtered or unexported fields
}

Agent is an object storing all request data for client. Agent instance MUST NOT be used from concurrently running goroutines.

func AcquireAgent added in v2.6.0 

func AcquireAgent() *Agent

AcquireAgent returns an empty Agent instance from Agent pool.

The returned Agent instance may be passed to ReleaseAgent when it is no longer needed. This allows Agent recycling, reduces GC pressure and usually improves performance.

func Delete added in v2.6.0 

func Delete(url string) *Agent

Delete sends DELETE request to the given URL.

func Get added in v2.6.0 

func Get(url string) *Agent

Get returns an agent with http method GET. 

func Head(url string) *Agent

Head returns an agent with http method HEAD.

func Patch added in v2.6.0 

func Patch(url string) *Agent

Patch sends PATCH request to the given URL.

func Post added in v2.6.0 

func Post(url string) *Agent

Post sends POST request to the given URL.

func Put added in v2.6.0 

func Put(url string) *Agent

Put sends PUT request to the given URL.

func (*Agent) Add added in v2.6.0 

func (a *Agent) Add(k, v string) *Agent

Add adds the given 'key: value' header.

Multiple headers with the same key may be added with this function. Use Set for setting a single header for the given key.

func (*Agent) AddBytesK added in v2.6.0 

func (a *Agent) AddBytesK(k []byte, v string) *Agent

AddBytesK adds the given 'key: value' header.

Multiple headers with the same key may be added with this function. Use SetBytesK for setting a single header for the given key.

func (*Agent) AddBytesKV added in v2.6.0 

func (a *Agent) AddBytesKV(k, v []byte) *Agent

AddBytesKV adds the given 'key: value' header.

Multiple headers with the same key may be added with this function. Use SetBytesKV for setting a single header for the given key.

func (*Agent) AddBytesV added in v2.6.0 

func (a *Agent) AddBytesV(k string, v []byte) *Agent

AddBytesV adds the given 'key: value' header.

Multiple headers with the same key may be added with this function. Use SetBytesV for setting a single header for the given key.

func (*Agent) BasicAuth added in v2.6.0 

func (a *Agent) BasicAuth(username, password string) *Agent

BasicAuth sets URI username and password.

func (*Agent) BasicAuthBytes added in v2.6.0 

func (a *Agent) BasicAuthBytes(username, password []byte) *Agent

BasicAuthBytes sets URI username and password.

func (*Agent) Body added in v2.6.0 

func (a *Agent) Body(body []byte) *Agent

Body sets request body.

func (*Agent) BodyStream added in v2.6.0 

func (a *Agent) BodyStream(bodyStream io.Reader, bodySize int) *Agent

BodyStream sets request body stream and, optionally body size.

If bodySize is >= 0, then the bodyStream must provide exactly bodySize bytes before returning io.EOF.

If bodySize < 0, then bodyStream is read until io.EOF.

bodyStream.Close() is called after finishing reading all body data if it implements io.Closer.

Note that GET and HEAD requests cannot have body.

func (*Agent) BodyString added in v2.6.0 

func (a *Agent) BodyString(bodyString string) *Agent

BodyString sets request body.

func (*Agent) Boundary added in v2.6.0 

func (a *Agent) Boundary(boundary string) *Agent

Boundary sets boundary for multipart form request.

func (*Agent) Bytes added in v2.6.0 

func (a *Agent) Bytes() (int, []byte, []error)

Bytes returns the status code, bytes body and errors of url.

it's not safe to use Agent after calling Agent.Bytes

func (*Agent) ConnectionClose added in v2.6.0 

func (a *Agent) ConnectionClose() *Agent

ConnectionClose sets 'Connection: close' header.

func (*Agent) ContentType added in v2.6.0 

func (a *Agent) ContentType(contentType string) *Agent

ContentType sets Content-Type header value.

func (*Agent) ContentTypeBytes added in v2.6.0 

func (a *Agent) ContentTypeBytes(contentType []byte) *Agent

ContentTypeBytes sets Content-Type header value.

func (*Agent) Cookie added in v2.6.0 

func (a *Agent) Cookie(key, value string) *Agent

Cookie sets one 'key: value' cookie.

func (*Agent) CookieBytesK added in v2.6.0 

func (a *Agent) CookieBytesK(key []byte, value string) *Agent

CookieBytesK sets one 'key: value' cookie.

func (*Agent) CookieBytesKV added in v2.6.0 

func (a *Agent) CookieBytesKV(key, value []byte) *Agent

CookieBytesKV sets one 'key: value' cookie.

func (*Agent) Cookies added in v2.6.0 

func (a *Agent) Cookies(kv ...string) *Agent

Cookies sets multiple 'key: value' cookies.

func (*Agent) CookiesBytesKV added in v2.6.0 

func (a *Agent) CookiesBytesKV(kv ...[]byte) *Agent

CookiesBytesKV sets multiple 'key: value' cookies.

func (*Agent) Debug added in v2.6.0 

func (a *Agent) Debug(w ...io.Writer) *Agent

Debug mode enables logging request and response detail

func (*Agent) Dest added in v2.6.0 

func (a *Agent) Dest(dest []byte) *Agent

Dest sets custom dest.

The contents of dest will be replaced by the response body, if the dest is too small a new slice will be allocated.

func (*Agent) FileData added in v2.6.0 

func (a *Agent) FileData(formFiles ...*FormFile) *Agent

FileData appends files for multipart form request.

It is recommended obtaining formFile via AcquireFormFile and release it manually in performance-critical code.

func (*Agent) Form added in v2.6.0 

func (a *Agent) Form(args *Args) *Agent

Form sends form request with body if args is non-nil.

It is recommended obtaining args via AcquireArgs and release it manually in performance-critical code.

func (*Agent) Host added in v2.6.0 

func (a *Agent) Host(host string) *Agent

Host sets host for the URI.

func (*Agent) HostBytes added in v2.6.0 

func (a *Agent) HostBytes(host []byte) *Agent

HostBytes sets host for the URI.

func (*Agent) InsecureSkipVerify added in v2.6.0 

func (a *Agent) InsecureSkipVerify() *Agent

InsecureSkipVerify controls whether the Agent verifies the server certificate chain and host name.

func (*Agent) JSON added in v2.6.0 

func (a *Agent) JSON(v interface{}, ctype ...string) *Agent

JSON sends a JSON request.

func (*Agent) JSONDecoder added in v2.6.0 

func (a *Agent) JSONDecoder(jsonDecoder utils.JSONUnmarshal) *Agent

JSONDecoder sets custom json decoder.

func (*Agent) JSONEncoder added in v2.6.0 

func (a *Agent) JSONEncoder(jsonEncoder utils.JSONMarshal) *Agent

JSONEncoder sets custom json encoder.

func (*Agent) MaxRedirectsCount added in v2.6.0 

func (a *Agent) MaxRedirectsCount(count int) *Agent

MaxRedirectsCount sets max redirect count for GET and HEAD.

func (*Agent) MultipartForm added in v2.6.0 

func (a *Agent) MultipartForm(args *Args) *Agent

MultipartForm sends multipart form request with k-v and files.

It is recommended obtaining args via AcquireArgs and release it manually in performance-critical code.

func (*Agent) Parse added in v2.6.0 

func (a *Agent) Parse() error

Parse initializes URI and HostClient.

func (*Agent) QueryString added in v2.6.0 

func (a *Agent) QueryString(queryString string) *Agent

QueryString sets URI query string.

func (*Agent) QueryStringBytes added in v2.6.0 

func (a *Agent) QueryStringBytes(queryString []byte) *Agent

QueryStringBytes sets URI query string.

func (*Agent) Referer added in v2.6.0 

func (a *Agent) Referer(referer string) *Agent

Referer sets Referer header value.

func (*Agent) RefererBytes added in v2.6.0 

func (a *Agent) RefererBytes(referer []byte) *Agent

RefererBytes sets Referer header value.

func (*Agent) Request added in v2.6.0 

func (a *Agent) Request() *Request

Request returns Agent request instance.

func (*Agent) RetryIf added in v2.26.0 

func (a *Agent) RetryIf(retryIf RetryIfFunc) *Agent

RetryIf controls whether a retry should be attempted after an error.

By default, will use isIdempotent function from fasthttp

func (*Agent) Reuse added in v2.6.0 

func (a *Agent) Reuse() *Agent

Reuse enables the Agent instance to be used again after one request.

If agent is reusable, then it should be released manually when it is no longer used.

func (*Agent) SendFile added in v2.6.0 

func (a *Agent) SendFile(filename string, fieldname ...string) *Agent

SendFile reads file and appends it to multipart form request.

func (*Agent) SendFiles added in v2.6.0 

func (a *Agent) SendFiles(filenamesAndFieldnames ...string) *Agent

SendFiles reads files and appends them to multipart form request.

Examples: 

SendFile("/path/to/file1", "fieldname1", "/path/to/file2")

func (*Agent) Set added in v2.6.0 

func (a *Agent) Set(k, v string) *Agent

Set sets the given 'key: value' header.

Use Add for setting multiple header values under the same key.

func (*Agent) SetBytesK added in v2.6.0 

func (a *Agent) SetBytesK(k []byte, v string) *Agent

SetBytesK sets the given 'key: value' header.

Use AddBytesK for setting multiple header values under the same key.

func (*Agent) SetBytesKV added in v2.6.0 

func (a *Agent) SetBytesKV(k, v []byte) *Agent

SetBytesKV sets the given 'key: value' header.

Use AddBytesKV for setting multiple header values under the same key.

func (*Agent) SetBytesV added in v2.6.0 

func (a *Agent) SetBytesV(k string, v []byte) *Agent

SetBytesV sets the given 'key: value' header.

Use AddBytesV for setting multiple header values under the same key.

func (*Agent) SetResponse added in v2.6.0 

func (a *Agent) SetResponse(customResp *Response) *Agent

SetResponse sets custom response for the Agent instance.

It is recommended obtaining custom response via AcquireResponse and release it manually in performance-critical code.

func (*Agent) String added in v2.6.0 

func (a *Agent) String() (int, string, []error)

String returns the status code, string body and errors of url.

it's not safe to use Agent after calling Agent.String

func (*Agent) Struct added in v2.6.0 

func (a *Agent) Struct(v interface{}) (int, []byte, []error)

Struct returns the status code, bytes body and errors of URL. And bytes body will be unmarshalled to given v.

it's not safe to use Agent after calling Agent.Struct

func (*Agent) TLSConfig added in v2.6.0 

func (a *Agent) TLSConfig(config *tls.Config) *Agent

TLSConfig sets tls config.

func (*Agent) Timeout added in v2.6.0 

func (a *Agent) Timeout(timeout time.Duration) *Agent

Timeout sets request timeout duration.

func (*Agent) UserAgent added in v2.6.0 

func (a *Agent) UserAgent(userAgent string) *Agent

UserAgent sets User-Agent header value.

func (*Agent) UserAgentBytes added in v2.6.0 

func (a *Agent) UserAgentBytes(userAgent []byte) *Agent

UserAgentBytes sets User-Agent header value.

func (*Agent) XML added in v2.6.0 

func (a *Agent) XML(v interface{}) *Agent

XML sends an XML request.

type App 

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

App denotes the Fiber application.

func New 

func New(config ...Config) *App

New creates a new Fiber named instance. 

app := fiber.New()

You can pass optional configuration options by passing a Config struct: 

app := fiber.New(fiber.Config{
    Prefork: true,
    ServerHeader: "Fiber",
})

func (*App) AcquireCtx 

func (app *App) AcquireCtx(fctx *fasthttp.RequestCtx) *Ctx

AcquireCtx retrieves a new Ctx from the pool.

func (*App) Add 

func (app *App) Add(method, path string, handlers ...Handler) Router

Add allows you to specify a HTTP method to register a route

func (*App) All 

func (app *App) All(path string, handlers ...Handler) Router

All will register the handler on all HTTP methods

func (*App) Config 

func (app *App) Config() Config

Config returns the app config as value ( read-only ).

func (*App) Connect 

func (app *App) Connect(path string, handlers ...Handler) Router

Connect registers a route for CONNECT methods that establishes a tunnel to the server identified by the target resource.

func (*App) Delete 

func (app *App) Delete(path string, handlers ...Handler) Router

Delete registers a route for DELETE methods that deletes the specified resource.

func (*App) ErrorHandler added in v2.20.0 

func (app *App) ErrorHandler(ctx *Ctx, err error) error

ErrorHandler is the application's method in charge of finding the appropriate handler for the given request. It searches any mounted sub fibers by their prefixes and if it finds a match, it uses that error handler. Otherwise it uses the configured error handler for the app, which if not set is the DefaultErrorHandler.

func (*App) Get 

func (app *App) Get(path string, handlers ...Handler) Router

Get registers a route for GET methods that requests a representation of the specified resource. Requests using GET should only retrieve data.

func (*App) GetRoute added in v2.24.0 

func (app *App) GetRoute(name string) Route

GetRoute Get route by name

func (*App) GetRoutes added in v2.39.0 

func (app *App) GetRoutes(filterUseOption ...bool) []Route

GetRoutes Get all routes. When filterUseOption equal to true, it will filter the routes registered by the middleware.

func (*App) Group 

func (app *App) Group(prefix string, handlers ...Handler) Router

Group is used for Routes with common prefix to define a new sub-router with optional middleware. 

api := app.Group("/api")
api.Get("/users", handler)

func (*App) Handler 

func (app *App) Handler() fasthttp.RequestHandler

Handler returns the server handler.

func (*App) HandlersCount added in v2.24.0 

func (app *App) HandlersCount() uint32

HandlersCount returns the amount of registered handlers.

func (*App) Head 

func (app *App) Head(path string, handlers ...Handler) Router

Head registers a route for HEAD methods that asks for a response identical to that of a GET request, but without the response body.

func (*App) Hooks added in v2.30.0 

func (app *App) Hooks() *Hooks

Hooks returns the hook struct to register hooks.

func (*App) Listen 

func (app *App) Listen(addr string) error

Listen serves HTTP requests from the given addr. 

app.Listen(":8080")
app.Listen("127.0.0.1:8080")

func (*App) ListenMutualTLS added in v2.28.0 

func (app *App) ListenMutualTLS(addr, certFile, keyFile, clientCertFile string) error

ListenMutualTLS serves HTTPS requests from the given addr. certFile, keyFile and clientCertFile are the paths to TLS certificate and key file: 

app.ListenMutualTLS(":8080", "./cert.pem", "./cert.key", "./client.pem")

func (*App) ListenMutualTLSWithCertificate added in v2.43.0 

func (app *App) ListenMutualTLSWithCertificate(addr string, cert tls.Certificate, clientCertPool *x509.CertPool) error

ListenMutualTLSWithCertificate serves HTTPS requests from the given addr. cert is a tls.Certificate and clientCertPool is a *x509.CertPool: 

app.ListenMutualTLS(":8080", cert, clientCertPool)

func (*App) ListenTLS added in v2.3.0 

func (app *App) ListenTLS(addr, certFile, keyFile string) error

ListenTLS serves HTTPS requests from the given addr. certFile and keyFile are the paths to TLS certificate and key file: 

app.ListenTLS(":8080", "./cert.pem", "./cert.key")

func (*App) ListenTLSWithCertificate added in v2.43.0 

func (app *App) ListenTLSWithCertificate(addr string, cert tls.Certificate) error

ListenTLS serves HTTPS requests from the given addr. cert is a tls.Certificate 

app.ListenTLSWithCertificate(":8080", cert)

func (*App) Listener 

func (app *App) Listener(ln net.Listener) error

Listener can be used to pass a custom listener.

func (*App) Mount added in v2.0.3 

func (app *App) Mount(prefix string, subApp *App) Router

Mount attaches another app instance as a sub-router along a routing path. It's very useful to split up a large API as many independent routers and compose them as a single service using Mount. The fiber's error handler and any of the fiber's sub apps are added to the application's error handlers to be invoked on errors that happen within the prefix route.

func (*App) MountPath added in v2.40.0 

func (app *App) MountPath() string

The MountPath property contains one or more path patterns on which a sub-app was mounted.

func (*App) Name added in v2.24.0 

func (app *App) Name(name string) Router

Name Assign name to specific route.

func (*App) Options 

func (app *App) Options(path string, handlers ...Handler) Router

Options registers a route for OPTIONS methods that is used to describe the communication options for the target resource.

func (*App) Patch 

func (app *App) Patch(path string, handlers ...Handler) Router

Patch registers a route for PATCH methods that is used to apply partial modifications to a resource.

func (*App) Post 

func (app *App) Post(path string, handlers ...Handler) Router

Post registers a route for POST methods that is used to submit an entity to the specified resource, often causing a change in state or side effects on the server.

func (*App) Put 

func (app *App) Put(path string, handlers ...Handler) Router

Put registers a route for PUT methods that replaces all current representations of the target resource with the request payload.

func (*App) ReleaseCtx 

func (app *App) ReleaseCtx(c *Ctx)

ReleaseCtx releases the ctx back into the pool.

func (*App) Route added in v2.26.0 

func (app *App) Route(prefix string, fn func(router Router), name ...string) Router

Route is used to define routes with a common prefix inside the common function. Uses Group method to define new sub-router.

func (*App) Server added in v2.0.3 

func (app *App) Server() *fasthttp.Server

Server returns the underlying fasthttp server

func (*App) SetTLSHandler added in v2.37.0 

func (app *App) SetTLSHandler(tlsHandler *TLSHandler)

SetTLSHandler You can use SetTLSHandler to use ClientHelloInfo when using TLS with Listener.

func (*App) Shutdown 

func (app *App) Shutdown() error

Shutdown gracefully shuts down the server without interrupting any active connections. Shutdown works by first closing all open listeners and then waiting indefinitely for all connections to return to idle before shutting down.

Make sure the program doesn't exit and waits instead for Shutdown to return.

Shutdown does not close keepalive connections so its recommended to set ReadTimeout to something else than 0.

func (*App) ShutdownWithContext added in v2.44.0 

func (app *App) ShutdownWithContext(ctx context.Context) error

ShutdownWithContext shuts down the server including by force if the context's deadline is exceeded.

Make sure the program doesn't exit and waits instead for ShutdownWithTimeout to return.

ShutdownWithContext does not close keepalive connections so its recommended to set ReadTimeout to something else than 0.

func (*App) ShutdownWithTimeout added in v2.41.0 

func (app *App) ShutdownWithTimeout(timeout time.Duration) error

ShutdownWithTimeout gracefully shuts down the server without interrupting any active connections. However, if the timeout is exceeded, ShutdownWithTimeout will forcefully close any active connections. ShutdownWithTimeout works by first closing all open listeners and then waiting for all connections to return to idle before shutting down.

Make sure the program doesn't exit and waits instead for ShutdownWithTimeout to return.

ShutdownWithTimeout does not close keepalive connections so its recommended to set ReadTimeout to something else than 0.

func (*App) Stack 

func (app *App) Stack() [][]*Route

Stack returns the raw router stack.

func (*App) Static 

func (app *App) Static(prefix, root string, config ...Static) Router

Static will create a file server serving static files

func (*App) Test 

func (app *App) Test(req *http.Request, msTimeout ...int) (*http.Response, error)

Test is used for internal debugging by passing a *http.Request. Timeout is optional and defaults to 1s, -1 will disable it completely.

func (*App) Trace 

func (app *App) Trace(path string, handlers ...Handler) Router

Trace registers a route for TRACE methods that performs a message loop-back test along the path to the target resource.

func (*App) Use 

func (app *App) Use(args ...interface{}) Router

Use registers a middleware route that will match requests with the provided prefix (which is optional and defaults to "/"). 

app.Use(func(c *fiber.Ctx) error {
     return c.Next()
})
app.Use("/api", func(c *fiber.Ctx) error {
     return c.Next()
})
app.Use("/api", handler, func(c *fiber.Ctx) error {
     return c.Next()
})

This method will match all HTTP verbs: GET, POST, PUT, HEAD etc...

type Args added in v2.6.0 

type Args = fasthttp.Args

Args represents query arguments.

It is forbidden copying Args instances. Create new instances instead and use CopyTo().

Args instance MUST NOT be used from concurrently running goroutines. Copy from fasthttp

func AcquireArgs added in v2.6.0 

func AcquireArgs() *Args

AcquireArgs returns an empty Args object from the pool.

The returned Args may be returned to the pool with ReleaseArgs when no longer needed. This allows reducing GC load. Copy from fasthttp

type Client added in v2.6.0 

type Client struct {

	// UserAgent is used in User-Agent request header.
	UserAgent string

	// NoDefaultUserAgentHeader when set to true, causes the default
	// User-Agent header to be excluded from the Request.
	NoDefaultUserAgentHeader bool

	// When set by an external client of Fiber it will use the provided implementation of a
	// JSONMarshal
	//
	// Allowing for flexibility in using another json library for encoding
	JSONEncoder utils.JSONMarshal

	// When set by an external client of Fiber it will use the provided implementation of a
	// JSONUnmarshal
	//
	// Allowing for flexibility in using another json library for decoding
	JSONDecoder utils.JSONUnmarshal
	// contains filtered or unexported fields
}

Client implements http client.

It is safe calling Client methods from concurrently running goroutines.

func AcquireClient added in v2.6.0 

func AcquireClient() *Client

AcquireClient returns an empty Client instance from client pool.

The returned Client instance may be passed to ReleaseClient when it is no longer needed. This allows Client recycling, reduces GC pressure and usually improves performance.

func (*Client) Delete added in v2.6.0 

func (c *Client) Delete(url string) *Agent

Delete sends DELETE request to the given URL.

func (*Client) Get added in v2.6.0 

func (c *Client) Get(url string) *Agent

Get returns an agent with http method GET.

func (*Client) Head added in v2.6.0 

func (c *Client) Head(url string) *Agent

Head returns an agent with http method GET.

func (*Client) Patch added in v2.6.0 

func (c *Client) Patch(url string) *Agent

Patch sends PATCH request to the given URL.

func (*Client) Post added in v2.6.0 

func (c *Client) Post(url string) *Agent

Post sends POST request to the given URL.

func (*Client) Put added in v2.6.0 

func (c *Client) Put(url string) *Agent

Put sends PUT request to the given URL.

type Colors added in v2.36.0 

type Colors struct {
	// Black color.
	//
	// Optional. Default: "\u001b[90m"
	Black string

	// Red color.
	//
	// Optional. Default: "\u001b[91m"
	Red string

	// Green color.
	//
	// Optional. Default: "\u001b[92m"
	Green string

	// Yellow color.
	//
	// Optional. Default: "\u001b[93m"
	Yellow string

	// Blue color.
	//
	// Optional. Default: "\u001b[94m"
	Blue string

	// Magenta color.
	//
	// Optional. Default: "\u001b[95m"
	Magenta string

	// Cyan color.
	//
	// Optional. Default: "\u001b[96m"
	Cyan string

	// White color.
	//
	// Optional. Default: "\u001b[97m"
	White string

	// Reset color.
	//
	// Optional. Default: "\u001b[0m"
	Reset string
}

Colors is a struct to define custom colors for Fiber app and middlewares.

type Config 

type Config struct {
	// When set to true, this will spawn multiple Go processes listening on the same port.
	//
	// Default: false
	Prefork bool `json:"prefork"`

	// Enables the "Server: value" HTTP header.
	//
	// Default: ""
	ServerHeader string `json:"server_header"`

	// When set to true, the router treats "/foo" and "/foo/" as different.
	// By default this is disabled and both "/foo" and "/foo/" will execute the same handler.
	//
	// Default: false
	StrictRouting bool `json:"strict_routing"`

	// When set to true, enables case sensitive routing.
	// E.g. "/FoO" and "/foo" are treated as different routes.
	// By default this is disabled and both "/FoO" and "/foo" will execute the same handler.
	//
	// Default: false
	CaseSensitive bool `json:"case_sensitive"`

	// When set to true, this relinquishes the 0-allocation promise in certain
	// cases in order to access the handler values (e.g. request bodies) in an
	// immutable fashion so that these values are available even if you return
	// from handler.
	//
	// Default: false
	Immutable bool `json:"immutable"`

	// When set to true, converts all encoded characters in the route back
	// before setting the path for the context, so that the routing,
	// the returning of the current url from the context `ctx.Path()`
	// and the parameters `ctx.Params(%key%)` with decoded characters will work
	//
	// Default: false
	UnescapePath bool `json:"unescape_path"`

	// Enable or disable ETag header generation, since both weak and strong etags are generated
	// using the same hashing method (CRC-32). Weak ETags are the default when enabled.
	//
	// Default: false
	ETag bool `json:"etag"`

	// Max body size that the server accepts.
	// -1 will decline any body size
	//
	// Default: 4 * 1024 * 1024
	BodyLimit int `json:"body_limit"`

	// Maximum number of concurrent connections.
	//
	// Default: 256 * 1024
	Concurrency int `json:"concurrency"`

	// Views is the interface that wraps the Render function.
	//
	// Default: nil
	Views Views `json:"-"`

	// Views Layout is the global layout for all template render until override on Render function.
	//
	// Default: ""
	ViewsLayout string `json:"views_layout"`

	// PassLocalsToViews Enables passing of the locals set on a fiber.Ctx to the template engine
	//
	// Default: false
	PassLocalsToViews bool `json:"pass_locals_to_views"`

	// The amount of time allowed to read the full request including body.
	// It is reset after the request handler has returned.
	// The connection's read deadline is reset when the connection opens.
	//
	// Default: unlimited
	ReadTimeout time.Duration `json:"read_timeout"`

	// The maximum duration before timing out writes of the response.
	// It is reset after the request handler has returned.
	//
	// Default: unlimited
	WriteTimeout time.Duration `json:"write_timeout"`

	// The maximum amount of time to wait for the next request when keep-alive is enabled.
	// If IdleTimeout is zero, the value of ReadTimeout is used.
	//
	// Default: unlimited
	IdleTimeout time.Duration `json:"idle_timeout"`

	// Per-connection buffer size for requests' reading.
	// This also limits the maximum header size.
	// Increase this buffer if your clients send multi-KB RequestURIs
	// and/or multi-KB headers (for example, BIG cookies).
	//
	// Default: 4096
	ReadBufferSize int `json:"read_buffer_size"`

	// Per-connection buffer size for responses' writing.
	//
	// Default: 4096
	WriteBufferSize int `json:"write_buffer_size"`

	// CompressedFileSuffix adds suffix to the original file name and
	// tries saving the resulting compressed file under the new file name.
	//
	// Default: ".fiber.gz"
	CompressedFileSuffix string `json:"compressed_file_suffix"`

	// ProxyHeader will enable c.IP() to return the value of the given header key
	// By default c.IP() will return the Remote IP from the TCP connection
	// This property can be useful if you are behind a load balancer: X-Forwarded-*
	// NOTE: headers are easily spoofed and the detected IP addresses are unreliable.
	//
	// Default: ""
	ProxyHeader string `json:"proxy_header"`

	// GETOnly rejects all non-GET requests if set to true.
	// This option is useful as anti-DoS protection for servers
	// accepting only GET requests. The request size is limited
	// by ReadBufferSize if GETOnly is set.
	//
	// Default: false
	GETOnly bool `json:"get_only"`

	// ErrorHandler is executed when an error is returned from fiber.Handler.
	//
	// Default: DefaultErrorHandler
	ErrorHandler ErrorHandler `json:"-"`

	// When set to true, disables keep-alive connections.
	// The server will close incoming connections after sending the first response to client.
	//
	// Default: false
	DisableKeepalive bool `json:"disable_keepalive"`

	// When set to true, causes the default date header to be excluded from the response.
	//
	// Default: false
	DisableDefaultDate bool `json:"disable_default_date"`

	// When set to true, causes the default Content-Type header to be excluded from the response.
	//
	// Default: false
	DisableDefaultContentType bool `json:"disable_default_content_type"`

	// When set to true, disables header normalization.
	// By default all header names are normalized: conteNT-tYPE -> Content-Type.
	//
	// Default: false
	DisableHeaderNormalizing bool `json:"disable_header_normalizing"`

	// When set to true, it will not print out the «Fiber» ASCII art and listening address.
	//
	// Default: false
	DisableStartupMessage bool `json:"disable_startup_message"`

	// This function allows to setup app name for the app
	//
	// Default: nil
	AppName string `json:"app_name"`

	// StreamRequestBody enables request body streaming,
	// and calls the handler sooner when given body is
	// larger then the current limit.
	StreamRequestBody bool

	// Will not pre parse Multipart Form data if set to true.
	//
	// This option is useful for servers that desire to treat
	// multipart form data as a binary blob, or choose when to parse the data.
	//
	// Server pre parses multipart form data by default.
	DisablePreParseMultipartForm bool

	// Aggressively reduces memory usage at the cost of higher CPU usage
	// if set to true.
	//
	// Try enabling this option only if the server consumes too much memory
	// serving mostly idle keep-alive connections. This may reduce memory
	// usage by more than 50%.
	//
	// Default: false
	ReduceMemoryUsage bool `json:"reduce_memory_usage"`

	// When set by an external client of Fiber it will use the provided implementation of a
	// JSONMarshal
	//
	// Allowing for flexibility in using another json library for encoding
	// Default: json.Marshal
	JSONEncoder utils.JSONMarshal `json:"-"`

	// When set by an external client of Fiber it will use the provided implementation of a
	// JSONUnmarshal
	//
	// Allowing for flexibility in using another json library for decoding
	// Default: json.Unmarshal
	JSONDecoder utils.JSONUnmarshal `json:"-"`

	// XMLEncoder set by an external client of Fiber it will use the provided implementation of a
	// XMLMarshal
	//
	// Allowing for flexibility in using another XML library for encoding
	// Default: xml.Marshal
	XMLEncoder utils.XMLMarshal `json:"-"`

	// Known networks are "tcp", "tcp4" (IPv4-only), "tcp6" (IPv6-only)
	// WARNING: When prefork is set to true, only "tcp4" and "tcp6" can be chose.
	//
	// Default: NetworkTCP4
	Network string

	// If you find yourself behind some sort of proxy, like a load balancer,
	// then certain header information may be sent to you using special X-Forwarded-* headers or the Forwarded header.
	// For example, the Host HTTP header is usually used to return the requested host.
	// But when you’re behind a proxy, the actual host may be stored in an X-Forwarded-Host header.
	//
	// If you are behind a proxy, you should enable TrustedProxyCheck to prevent header spoofing.
	// If you enable EnableTrustedProxyCheck and leave TrustedProxies empty Fiber will skip
	// all headers that could be spoofed.
	// If request ip in TrustedProxies whitelist then:
	//   1. c.Protocol() get value from X-Forwarded-Proto, X-Forwarded-Protocol, X-Forwarded-Ssl or X-Url-Scheme header
	//   2. c.IP() get value from ProxyHeader header.
	//   3. c.Hostname() get value from X-Forwarded-Host header
	// But if request ip NOT in Trusted Proxies whitelist then:
	//   1. c.Protocol() WON't get value from X-Forwarded-Proto, X-Forwarded-Protocol, X-Forwarded-Ssl or X-Url-Scheme header,
	//    will return https in case when tls connection is handled by the app, of http otherwise
	//   2. c.IP() WON'T get value from ProxyHeader header, will return RemoteIP() from fasthttp context
	//   3. c.Hostname() WON'T get value from X-Forwarded-Host header, fasthttp.Request.URI().Host()
	//    will be used to get the hostname.
	//
	// Default: false
	EnableTrustedProxyCheck bool `json:"enable_trusted_proxy_check"`

	// Read EnableTrustedProxyCheck doc.
	//
	// Default: []string
	TrustedProxies []string `json:"trusted_proxies"`

	// If set to true, c.IP() and c.IPs() will validate IP addresses before returning them.
	// Also, c.IP() will return only the first valid IP rather than just the raw header
	// WARNING: this has a performance cost associated with it.
	//
	// Default: false
	EnableIPValidation bool `json:"enable_ip_validation"`

	// If set to true, will print all routes with their method, path and handler.
	// Default: false
	EnablePrintRoutes bool `json:"enable_print_routes"`

	// You can define custom color scheme. They'll be used for startup message, route list and some middlewares.
	//
	// Optional. Default: DefaultColors
	ColorScheme Colors `json:"color_scheme"`

	// RequestMethods provides customizibility for HTTP methods. You can add/remove methods as you wish.
	//
	// Optional. Default: DefaultMethods
	RequestMethods []string

	// EnableSplittingOnParsers splits the query/body/header parameters by comma when it's true.
	// For example, you can use it to parse multiple values from a query parameter like this:
	//   /api?foo=bar,baz == foo[]=bar&foo[]=baz
	//
	// Optional. Default: false
	EnableSplittingOnParsers bool `json:"enable_splitting_on_parsers"`
	// contains filtered or unexported fields
}

Config is a struct holding the server settings.

type Constraint added in v2.37.0 

type Constraint struct {
	ID            TypeConstraint
	RegexCompiler *regexp.Regexp
	Data          []string
}

func (*Constraint) CheckConstraint added in v2.37.0 

func (c *Constraint) CheckConstraint(param string) bool

type ConversionError added in v2.13.0 

type ConversionError = schema.ConversionError

ConversionError Conversion error exposes the internal schema.ConversionError for public use. 

type Cookie struct {
	Name        string    `json:"name"`
	Value       string    `json:"value"`
	Path        string    `json:"path"`
	Domain      string    `json:"domain"`
	MaxAge      int       `json:"max_age"`
	Expires     time.Time `json:"expires"`
	Secure      bool      `json:"secure"`
	HTTPOnly    bool      `json:"http_only"`
	SameSite    string    `json:"same_site"`
	SessionOnly bool      `json:"session_only"`
}

Cookie data for c.Cookie

type Ctx 

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

Ctx represents the Context which hold the HTTP request and response. It has methods for the request query string, parameters, body, HTTP headers and so on.

func (*Ctx) Accepts 

func (c *Ctx) Accepts(offers ...string) string

Accepts checks if the specified extensions or content types are acceptable.

func (*Ctx) AcceptsCharsets 

func (c *Ctx) AcceptsCharsets(offers ...string) string

AcceptsCharsets checks if the specified charset is acceptable.

func (*Ctx) AcceptsEncodings 

func (c *Ctx) AcceptsEncodings(offers ...string) string

AcceptsEncodings checks if the specified encoding is acceptable.

func (*Ctx) AcceptsLanguages 

func (c *Ctx) AcceptsLanguages(offers ...string) string

AcceptsLanguages checks if the specified language is acceptable.

func (*Ctx) AllParams added in v2.32.0 

func (c *Ctx) AllParams() map[string]string

AllParams Params is used to get all route parameters. Using Params method to get params.

func (*Ctx) App 

func (c *Ctx) App() *App

App returns the *App reference to the instance of the Fiber application

func (*Ctx) Append 

func (c *Ctx) Append(field string, values ...string)

Append the specified value to the HTTP response header field. If the header is not already set, it creates the header with the specified value.

func (*Ctx) Attachment 

func (c *Ctx) Attachment(filename ...string)

Attachment sets the HTTP response Content-Disposition header field to attachment.

func (*Ctx) BaseURL 

func (c *Ctx) BaseURL() string

BaseURL returns (protocol + host + base path).

func (*Ctx) Bind added in v2.27.0 

func (c *Ctx) Bind(vars Map) error

Bind Add vars to default view var map binding to template engine. Variables are read by the Render method and may be overwritten.

func (*Ctx) Body 

func (c *Ctx) Body() []byte

Body contains the raw body submitted in a POST request. This method will decompress the body if the 'Content-Encoding' header is provided. It returns the original (or decompressed) body data which is valid only within the handler. Don't store direct references to the returned data. If you need to keep the body's data later, make a copy or use the Immutable option.

func (*Ctx) BodyParser 

func (c *Ctx) BodyParser(out interface{}) error

BodyParser binds the request body to a struct. It supports decoding the following content types based on the Content-Type header: application/json, application/xml, application/x-www-form-urlencoded, multipart/form-data All JSON extenstion mime types are supported (eg. application/problem+json) If none of the content types above are matched, it will return a ErrUnprocessableEntity error

func (*Ctx) BodyRaw added in v2.49.0 

func (c *Ctx) BodyRaw() []byte

BodyRaw contains the raw body submitted in a POST request. Returned value is only valid within the handler. Do not store any references. Make copies or use the Immutable setting instead.

func (*Ctx) ClearCookie 

func (c *Ctx) ClearCookie(key ...string)

ClearCookie expires a specific cookie by key on the client side. If no key is provided it expires all cookies that came with the request.

func (*Ctx) ClientHelloInfo added in v2.37.0 

func (c *Ctx) ClientHelloInfo() *tls.ClientHelloInfo

ClientHelloInfo return CHI from context

func (*Ctx) Context 

func (c *Ctx) Context() *fasthttp.RequestCtx

Context returns *fasthttp.RequestCtx that carries a deadline a cancellation signal, and other values across API boundaries.

func (*Ctx) Cookie 

func (c *Ctx) Cookie(cookie *Cookie)

Cookie sets a cookie by passing a cookie struct.

func (*Ctx) CookieParser added in v2.50.0 

func (c *Ctx) CookieParser(out interface{}) error

CookieParser is used to bind cookies to a struct

func (*Ctx) Cookies 

func (c *Ctx) Cookies(key string, defaultValue ...string) string

Cookies are used for getting a cookie value by key. Defaults to the empty string "" if the cookie doesn't exist. If a default value is given, it will return that value if the cookie doesn't exist. The returned value is only valid within the handler. Do not store any references. Make copies or use the Immutable setting to use the value outside the Handler.

func (*Ctx) Download 

func (c *Ctx) Download(file string, filename ...string) error

Download transfers the file from path as an attachment. Typically, browsers will prompt the user for download. By default, the Content-Disposition header filename= parameter is the filepath (this typically appears in the browser dialog). Override this default with the filename parameter.

func (*Ctx) FormFile 

func (c *Ctx) FormFile(key string) (*multipart.FileHeader, error)

FormFile returns the first file by key from a MultipartForm.

func (*Ctx) FormValue 

func (c *Ctx) FormValue(key string, defaultValue ...string) string

FormValue returns the first value by key from a MultipartForm. Search is performed in QueryArgs, PostArgs, MultipartForm and FormFile in this particular order. Defaults to the empty string "" if the form value doesn't exist. If a default value is given, it will return that value if the form value does not exist. Returned value is only valid within the handler. Do not store any references. Make copies or use the Immutable setting instead.

func (*Ctx) Format 

func (c *Ctx) Format(body interface{}) error

Format performs content-negotiation on the Accept HTTP header. It uses Accepts to select a proper format. If the header is not specified or there is no proper format, text/plain is used.

func (*Ctx) Fresh 

func (c *Ctx) Fresh() bool

Fresh returns true when the response is still “fresh” in the client's cache, otherwise false is returned to indicate that the client cache is now stale and the full response should be sent. When a client sends the Cache-Control: no-cache request header to indicate an end-to-end reload request, this module will return false to make handling these requests transparent. https://github.com/jshttp/fresh/blob/10e0471669dbbfbfd8de65bc6efac2ddd0bfa057/index.js#L33

func (*Ctx) Get 

func (c *Ctx) Get(key string, defaultValue ...string) string

Get returns the HTTP request header specified by field. Field names are case-insensitive Returned value is only valid within the handler. Do not store any references. Make copies or use the Immutable setting instead.

func (*Ctx) GetReqHeaders added in v2.24.0 

func (c *Ctx) GetReqHeaders() map[string][]string

GetReqHeaders returns the HTTP request headers. Returned value is only valid within the handler. Do not store any references. Make copies or use the Immutable setting instead.

func (*Ctx) GetRespHeader added in v2.17.0 

func (c *Ctx) GetRespHeader(key string, defaultValue ...string) string

GetRespHeader returns the HTTP response header specified by field. Field names are case-insensitive Returned value is only valid within the handler. Do not store any references. Make copies or use the Immutable setting instead.

func (*Ctx) GetRespHeaders added in v2.24.0 

func (c *Ctx) GetRespHeaders() map[string][]string

GetRespHeaders returns the HTTP response headers. Returned value is only valid within the handler. Do not store any references. Make copies or use the Immutable setting instead.

func (*Ctx) GetRouteURL added in v2.31.0 

func (c *Ctx) GetRouteURL(routeName string, params Map) (string, error)

GetRouteURL generates URLs to named routes, with parameters. URLs are relative, for example: "/user/1831"

func (*Ctx) Hostname 

func (c *Ctx) Hostname() string

Hostname contains the hostname derived from the X-Forwarded-Host or Host HTTP header. Returned value is only valid within the handler. Do not store any references. Make copies or use the Immutable setting instead. Please use Config.EnableTrustedProxyCheck to prevent header spoofing, in case when your app is behind the proxy.

func (*Ctx) IP 

func (c *Ctx) IP() string

IP returns the remote IP address of the request. If ProxyHeader and IP Validation is configured, it will parse that header and return the first valid IP address. Please use Config.EnableTrustedProxyCheck to prevent header spoofing, in case when your app is behind the proxy.

func (*Ctx) IPs 

func (c *Ctx) IPs() []string

IPs returns a string slice of IP addresses specified in the X-Forwarded-For request header. When IP validation is enabled, only valid IPs are returned.

func (*Ctx) Is 

func (c *Ctx) Is(extension string) bool

Is returns the matching content type, if the incoming request's Content-Type HTTP header field matches the MIME type specified by the type parameter

func (*Ctx) IsFromLocal added in v2.24.0 

func (c *Ctx) IsFromLocal() bool

IsFromLocal will return true if request came from local.

func (*Ctx) IsProxyTrusted added in v2.14.0 

func (c *Ctx) IsProxyTrusted() bool

func (*Ctx) JSON 

func (c *Ctx) JSON(data interface{}, ctype ...string) error

JSON converts any interface or string to JSON. Array and slice values encode as JSON arrays, except that []byte encodes as a base64-encoded string, and a nil slice encodes as the null JSON value. If the ctype parameter is given, this method will set the Content-Type header equal to ctype. If ctype is not given, The Content-Type header will be set to application/json.

func (*Ctx) JSONP 

func (c *Ctx) JSONP(data interface{}, callback ...string) error

JSONP sends a JSON response with JSONP support. This method is identical to JSON, except that it opts-in to JSONP callback support. By default, the callback name is simply callback. 

func (c *Ctx) Links(link ...string)

Links joins the links followed by the property to populate the response's Link HTTP header field.

func (*Ctx) Locals 

func (c *Ctx) Locals(key interface{}, value ...interface{}) interface{}

Locals makes it possible to pass interface{} values under keys scoped to the request and therefore available to all following routes that match the request.

func (*Ctx) Location 

func (c *Ctx) Location(path string)

Location sets the response Location HTTP header to the specified path parameter.

func (*Ctx) Method 

func (c *Ctx) Method(override ...string) string

Method returns the HTTP request method for the context, optionally overridden by the provided argument. If no override is given or if the provided override is not a valid HTTP method, it returns the current method from the context. Otherwise, it updates the context's method and returns the overridden method as a string.

func (*Ctx) MultipartForm 

func (c *Ctx) MultipartForm() (*multipart.Form, error)

MultipartForm parse form entries from binary. This returns a map[string][]string, so given a key the value will be a string slice.

func (*Ctx) Next 

func (c *Ctx) Next() error

Next executes the next method in the stack that matches the current route.

func (*Ctx) OriginalURL 

func (c *Ctx) OriginalURL() string

OriginalURL contains the original request URL. Returned value is only valid within the handler. Do not store any references. Make copies or use the Immutable setting to use the value outside the Handler.

func (*Ctx) Params 

func (c *Ctx) Params(key string, defaultValue ...string) string

Params is used to get the route parameters. Defaults to empty string "" if the param doesn't exist. If a default value is given, it will return that value if the param doesn't exist. Returned value is only valid within the handler. Do not store any references. Make copies or use the Immutable setting to use the value outside the Handler.

func (*Ctx) ParamsInt added in v2.7.0 

func (c *Ctx) ParamsInt(key string, defaultValue ...int) (int, error)

ParamsInt is used to get an integer from the route parameters it defaults to zero if the parameter is not found or if the parameter cannot be converted to an integer If a default value is given, it will return that value in case the param doesn't exist or cannot be converted to an integer

func (*Ctx) ParamsParser added in v2.35.0 

func (c *Ctx) ParamsParser(out interface{}) error

ParamsParser binds the param string to a struct.

func (*Ctx) Path 

func (c *Ctx) Path(override ...string) string

Path returns the path part of the request URL. Optionally, you could override the path.

func (*Ctx) Port added in v2.17.0 

func (c *Ctx) Port() string

Port returns the remote port of the request.

func (*Ctx) Protocol 

func (c *Ctx) Protocol() string

Protocol contains the request protocol string: http or https for TLS requests. Please use Config.EnableTrustedProxyCheck to prevent header spoofing, in case when your app is behind the proxy.

func (*Ctx) Queries added in v2.47.0 

func (c *Ctx) Queries() map[string]string

Queries returns a map of query parameters and their values.

GET /?name=alex&wanna_cake=2&id= Queries()["name"] == "alex" Queries()["wanna_cake"] == "2" Queries()["id"] == ""

GET /?field1=value1&field1=value2&field2=value3 Queries()["field1"] == "value2" Queries()["field2"] == "value3"

GET /?list_a=1&list_a=2&list_a=3&list_b[]=1&list_b[]=2&list_b[]=3&list_c=1,2,3 Queries()["list_a"] == "3" Queries()["list_b[]"] == "3" Queries()["list_c"] == "1,2,3"

GET /api/search?filters.author.name=John&filters.category.name=Technology&filters[customer][name]=Alice&filters[status]=pending Queries()["filters.author.name"] == "John" Queries()["filters.category.name"] == "Technology" Queries()["filters[customer][name]"] == "Alice" Queries()["filters[status]"] == "pending"

func (*Ctx) Query 

func (c *Ctx) Query(key string, defaultValue ...string) string

Query returns the query string parameter in the url. Defaults to empty string "" if the query doesn't exist. If a default value is given, it will return that value if the query doesn't exist. Returned value is only valid within the handler. Do not store any references. Make copies or use the Immutable setting to use the value outside the Handler.

func (*Ctx) QueryBool added in v2.43.0 

func (c *Ctx) QueryBool(key string, defaultValue ...bool) bool

QueryBool returns bool value of key string parameter in the url. Default to empty or invalid key is true. 

Get /?name=alex&want_pizza=false&id=
QueryBool("want_pizza") == false
QueryBool("want_pizza", true) == false
QueryBool("name") == false
QueryBool("name", true) == true
QueryBool("id") == false
QueryBool("id", true) == true

func (*Ctx) QueryFloat added in v2.43.0 

func (c *Ctx) QueryFloat(key string, defaultValue ...float64) float64

QueryFloat returns float64 value of key string parameter in the url. Default to empty or invalid key is 0. 

GET /?name=alex&amount=32.23&id=
QueryFloat("amount") = 32.23
QueryFloat("amount", 3) = 32.23
QueryFloat("name", 1) = 1
QueryFloat("name") = 0
QueryFloat("id", 3) = 3

func (*Ctx) QueryInt added in v2.42.0 

func (c *Ctx) QueryInt(key string, defaultValue ...int) int

QueryInt returns integer value of key string parameter in the url. Default to empty or invalid key is 0. 

GET /?name=alex&wanna_cake=2&id=
QueryInt("wanna_cake", 1) == 2
QueryInt("name", 1) == 1
QueryInt("id", 1) == 1
QueryInt("id") == 0

func (*Ctx) QueryParser 

func (c *Ctx) QueryParser(out interface{}) error

QueryParser binds the query string to a struct.

func (*Ctx) Range 

func (c *Ctx) Range(size int) (Range, error)

Range returns a struct containing the type and a slice of ranges.

func (*Ctx) Redirect 

func (c *Ctx) Redirect(location string, status ...int) error

Redirect to the URL derived from the specified path, with specified status. If status is not specified, status defaults to 302 Found.

func (*Ctx) RedirectBack added in v2.27.0 

func (c *Ctx) RedirectBack(fallback string, status ...int) error

RedirectBack to the URL to referer If status is not specified, status defaults to 302 Found.

func (*Ctx) RedirectToRoute added in v2.27.0 

func (c *Ctx) RedirectToRoute(routeName string, params Map, status ...int) error

RedirectToRoute to the Route registered in the app with appropriate parameters If status is not specified, status defaults to 302 Found. If you want to send queries to route, you must add "queries" key typed as map[string]string to params.

func (*Ctx) Render 

func (c *Ctx) Render(name string, bind interface{}, layouts ...string) error

Render a template with data and sends a text/html response. We support the following engines: html, amber, handlebars, mustache, pug

func (*Ctx) ReqHeaderParser added in v2.26.0 

func (c *Ctx) ReqHeaderParser(out interface{}) error

ReqHeaderParser binds the request header strings to a struct.

func (*Ctx) Request 

func (c *Ctx) Request() *fasthttp.Request

Request return the *fasthttp.Request object This allows you to use all fasthttp request methods https://godoc.org/github.com/valyala/fasthttp#Request

func (*Ctx) Response 

func (c *Ctx) Response() *fasthttp.Response

Response return the *fasthttp.Response object This allows you to use all fasthttp response methods https://godoc.org/github.com/valyala/fasthttp#Response

func (*Ctx) RestartRouting added in v2.27.0 

func (c *Ctx) RestartRouting() error

RestartRouting instead of going to the next handler. This may be useful after changing the request path. Note that handlers might be executed again.

func (*Ctx) Route 

func (c *Ctx) Route() *Route

Route returns the matched Route struct.

func (*Ctx) SaveFile 

func (*Ctx) SaveFile(fileheader *multipart.FileHeader, path string) error

SaveFile saves any multipart file to disk.

func (*Ctx) SaveFileToStorage added in v2.27.0 

func (*Ctx) SaveFileToStorage(fileheader *multipart.FileHeader, path string, storage Storage) error

SaveFileToStorage saves any multipart file to an external storage system.

func (*Ctx) Secure 

func (c *Ctx) Secure() bool

Secure returns whether a secure connection was established.

func (*Ctx) Send 

func (c *Ctx) Send(body []byte) error

Send sets the HTTP response body without copying it. From this point onward the body argument must not be changed.

func (*Ctx) SendFile 

func (c *Ctx) SendFile(file string, compress ...bool) error

SendFile transfers the file from the given path. The file is not compressed by default, enable this by passing a 'true' argument Sets the Content-Type response HTTP header field based on the filenames extension.

func (*Ctx) SendStatus 

func (c *Ctx) SendStatus(status int) error

SendStatus sets the HTTP status code and if the response body is empty, it sets the correct status message in the body.

func (*Ctx) SendStream 

func (c *Ctx) SendStream(stream io.Reader, size ...int) error

SendStream sets response body stream and optional body size.

func (*Ctx) SendString 

func (c *Ctx) SendString(body string) error

SendString sets the HTTP response body for string types. This means no type assertion, recommended for faster performance

func (*Ctx) Set 

func (c *Ctx) Set(key, val string)

Set sets the response's HTTP header field to the specified key, value.

func (*Ctx) SetUserContext added in v2.11.0 

func (c *Ctx) SetUserContext(ctx context.Context)

SetUserContext sets a context implementation by user.

func (*Ctx) Stale 

func (c *Ctx) Stale() bool

Stale is not implemented yet, pull requests are welcome!

func (*Ctx) Status 

func (c *Ctx) Status(status int) *Ctx

Status sets the HTTP status for the response. This method is chainable.

func (*Ctx) String 

func (c *Ctx) String() string

String returns unique string representation of the ctx.

The returned value may be useful for logging.

func (*Ctx) Subdomains 

func (c *Ctx) Subdomains(offset ...int) []string

Subdomains returns a string slice of subdomains in the domain name of the request. The subdomain offset, which defaults to 2, is used for determining the beginning of the subdomain segments.

func (*Ctx) Type 

func (c *Ctx) Type(extension string, charset ...string) *Ctx

Type sets the Content-Type HTTP header to the MIME type specified by the file extension.

func (*Ctx) UserContext added in v2.11.0 

func (c *Ctx) UserContext() context.Context

UserContext returns a context implementation that was set by user earlier or returns a non-nil, empty context,if it was not set earlier.

func (*Ctx) Vary 

func (c *Ctx) Vary(fields ...string)

Vary adds the given header field to the Vary response header. This will append the header, if not already listed, otherwise leaves it listed in the current location.

func (*Ctx) Write 

func (c *Ctx) Write(p []byte) (int, error)

Write appends p into response body.

func (*Ctx) WriteString added in v2.0.2 

func (c *Ctx) WriteString(s string) (int, error)

WriteString appends s to response body.

func (*Ctx) Writef added in v2.32.0 

func (c *Ctx) Writef(f string, a ...interface{}) (int, error)

Writef appends f & a into response body writer.

func (*Ctx) XHR 

func (c *Ctx) XHR() bool

XHR returns a Boolean property, that is true, if the request's X-Requested-With header field is XMLHttpRequest, indicating that the request was issued by a client library (such as jQuery).

func (*Ctx) XML added in v2.37.0 

func (c *Ctx) XML(data interface{}) error

XML converts any interface or string to XML. This method also sets the content header to application/xml.

type EmptyFieldError added in v2.13.0 

type EmptyFieldError = schema.EmptyFieldError

EmptyFieldError error exposes the internal schema.EmptyFieldError for public use.

type Error 

type Error struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}

Error represents an error that occurred while handling a request.

func NewError 

func NewError(code int, message ...string) *Error

NewError creates a new Error instance with an optional message

func (*Error) Error 

func (e *Error) Error() string

Error makes it compatible with the `error` interface.

type ErrorHandler 

type ErrorHandler = func(*Ctx, error) error

ErrorHandler defines a function that will process all errors returned from any handlers in the stack 

cfg := fiber.Config{}
cfg.ErrorHandler = func(c *Ctx, err error) error {
 code := StatusInternalServerError
 var e *fiber.Error
 if errors.As(err, &e) {
   code = e.Code
 }
 c.Set(HeaderContentType, MIMETextPlainCharsetUTF8)
 return c.Status(code).SendString(err.Error())
}
app := fiber.New(cfg)

type FormFile added in v2.6.0 

type FormFile struct {
	// Fieldname is form file's field name
	Fieldname string
	// Name is form file's name
	Name string
	// Content is form file's content
	Content []byte
	// contains filtered or unexported fields
}

FormFile represents multipart form file

func AcquireFormFile added in v2.6.0 

func AcquireFormFile() *FormFile

AcquireFormFile returns an empty FormFile object from the pool.

The returned FormFile may be returned to the pool with ReleaseFormFile when no longer needed. This allows reducing GC load.

type Group 

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

Group struct

func (*Group) Add 

func (grp *Group) Add(method, path string, handlers ...Handler) Router

Add allows you to specify a HTTP method to register a route

func (*Group) All 

func (grp *Group) All(path string, handlers ...Handler) Router

All will register the handler on all HTTP methods

func (*Group) Connect 

func (grp *Group) Connect(path string, handlers ...Handler) Router

Connect registers a route for CONNECT methods that establishes a tunnel to the server identified by the target resource.

func (*Group) Delete 

func (grp *Group) Delete(path string, handlers ...Handler) Router

Delete registers a route for DELETE methods that deletes the specified resource.

func (*Group) Get 

func (grp *Group) Get(path string, handlers ...Handler) Router

Get registers a route for GET methods that requests a representation of the specified resource. Requests using GET should only retrieve data.

func (*Group) Group 

func (grp *Group) Group(prefix string, handlers ...Handler) Router

Group is used for Routes with common prefix to define a new sub-router with optional middleware. 

api := app.Group("/api")
api.Get("/users", handler)

func (*Group) Head 

func (grp *Group) Head(path string, handlers ...Handler) Router

Head registers a route for HEAD methods that asks for a response identical to that of a GET request, but without the response body.

func (*Group) Mount added in v2.0.3 

func (grp *Group) Mount(prefix string, subApp *App) Router

Mount attaches another app instance as a sub-router along a routing path. It's very useful to split up a large API as many independent routers and compose them as a single service using Mount.

func (*Group) Name added in v2.24.0 

func (grp *Group) Name(name string) Router

Name Assign name to specific route or group itself.

If this method is used before any route added to group, it'll set group name and OnGroupNameHook will be used. Otherwise, it'll set route name and OnName hook will be used.

func (*Group) Options 

func (grp *Group) Options(path string, handlers ...Handler) Router

Options registers a route for OPTIONS methods that is used to describe the communication options for the target resource.

func (*Group) Patch 

func (grp *Group) Patch(path string, handlers ...Handler) Router

Patch registers a route for PATCH methods that is used to apply partial modifications to a resource.

func (*Group) Post 

func (grp *Group) Post(path string, handlers ...Handler) Router

Post registers a route for POST methods that is used to submit an entity to the specified resource, often causing a change in state or side effects on the server.

func (*Group) Put 

func (grp *Group) Put(path string, handlers ...Handler) Router

Put registers a route for PUT methods that replaces all current representations of the target resource with the request payload.

func (*Group) Route added in v2.26.0 

func (grp *Group) Route(prefix string, fn func(router Router), name ...string) Router

Route is used to define routes with a common prefix inside the common function. Uses Group method to define new sub-router.

func (*Group) Static 

func (grp *Group) Static(prefix, root string, config ...Static) Router

Static will create a file server serving static files

func (*Group) Trace 

func (grp *Group) Trace(path string, handlers ...Handler) Router

Trace registers a route for TRACE methods that performs a message loop-back test along the path to the target resource.

func (*Group) Use 

func (grp *Group) Use(args ...interface{}) Router

Use registers a middleware route that will match requests with the provided prefix (which is optional and defaults to "/"). 

app.Use(func(c *fiber.Ctx) error {
     return c.Next()
})
app.Use("/api", func(c *fiber.Ctx) error {
     return c.Next()
})
app.Use("/api", handler, func(c *fiber.Ctx) error {
     return c.Next()
})

This method will match all HTTP verbs: GET, POST, PUT, HEAD etc...

type Handler 

type Handler = func(*Ctx) error

Handler defines a function to serve HTTP requests.

type Hooks added in v2.37.0 

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

Hooks is a struct to use it with App.

func (*Hooks) OnFork added in v2.37.0 

func (h *Hooks) OnFork(handler ...OnForkHandler)

OnFork is a hook to execute user function after fork process.

func (*Hooks) OnGroup added in v2.37.0 

func (h *Hooks) OnGroup(handler ...OnGroupHandler)

OnGroup is a hook to execute user functions on each group registeration. Also you can get group properties by group parameter.

func (*Hooks) OnGroupName added in v2.37.0 

func (h *Hooks) OnGroupName(handler ...OnGroupNameHandler)

OnGroupName is a hook to execute user functions on each group naming. Also you can get group properties by group parameter.

WARN: OnGroupName only works with naming groups, not routes.

func (*Hooks) OnListen added in v2.37.0 

func (h *Hooks) OnListen(handler ...OnListenHandler)

OnListen is a hook to execute user functions on Listen, ListenTLS, Listener.

func (*Hooks) OnMount added in v2.40.0 

func (h *Hooks) OnMount(handler ...OnMountHandler)

OnMount is a hook to execute user function after mounting process. The mount event is fired when sub-app is mounted on a parent app. The parent app is passed as a parameter. It works for app and group mounting.

func (*Hooks) OnName added in v2.37.0 

func (h *Hooks) OnName(handler ...OnNameHandler)

OnName is a hook to execute user functions on each route naming. Also you can get route properties by route parameter.

WARN: OnName only works with naming routes, not groups.

func (*Hooks) OnRoute added in v2.37.0 

func (h *Hooks) OnRoute(handler ...OnRouteHandler)

OnRoute is a hook to execute user functions on each route registeration. Also you can get route properties by route parameter.

func (*Hooks) OnShutdown added in v2.37.0 

func (h *Hooks) OnShutdown(handler ...OnShutdownHandler)

OnShutdown is a hook to execute user functions after Shutdown.

type InvalidUnmarshalError added in v2.27.0 

type InvalidUnmarshalError = errors.InvalidUnmarshalError

An InvalidUnmarshalError describes an invalid argument passed to Unmarshal. (The argument to Unmarshal must be a non-nil pointer.)

type ListenData added in v2.48.0 

type ListenData struct {
	Host string
	Port string
	TLS  bool
}

ListenData is a struct to use it with OnListenHandler

type Map 

type Map map[string]interface{}

Map is a shortcut for map[string]interface{}, useful for JSON returns

type MarshalerError added in v2.27.0 

type MarshalerError = errors.MarshalerError

A MarshalerError represents an error from calling a MarshalJSON or MarshalText method.

type MultiError added in v2.13.0 

type MultiError = schema.MultiError

MultiError error exposes the internal schema.MultiError for public use.

type OnForkHandler added in v2.36.0 

type OnForkHandler = func(int) error

OnRouteHandler Handlers define a function to create hooks for Fiber.

type OnGroupHandler added in v2.30.0 

type OnGroupHandler = func(Group) error

OnRouteHandler Handlers define a function to create hooks for Fiber.

type OnGroupNameHandler added in v2.30.0 

type OnGroupNameHandler = OnGroupHandler

OnRouteHandler Handlers define a function to create hooks for Fiber.

type OnListenHandler added in v2.30.0 

type OnListenHandler = func(ListenData) error

OnRouteHandler Handlers define a function to create hooks for Fiber.

type OnMountHandler added in v2.40.0 

type OnMountHandler = func(*App) error

OnRouteHandler Handlers define a function to create hooks for Fiber.

type OnNameHandler added in v2.30.0 

type OnNameHandler = OnRouteHandler

OnRouteHandler Handlers define a function to create hooks for Fiber.

type OnRouteHandler added in v2.30.0 

type OnRouteHandler = func(Route) error

OnRouteHandler Handlers define a function to create hooks for Fiber.

type OnShutdownHandler added in v2.30.0 

type OnShutdownHandler = func() error

OnRouteHandler Handlers define a function to create hooks for Fiber.

type ParserConfig added in v2.20.0 

type ParserConfig struct {
	IgnoreUnknownKeys bool
	SetAliasTag       string
	ParserType        []ParserType
	ZeroEmpty         bool
}

ParserConfig form decoder config for SetParserDecoder

type ParserType added in v2.20.0 

type ParserType struct {
	Customtype interface{}
	Converter  func(string) reflect.Value
}

ParserType require two element, type and converter for register. Use ParserType with BodyParser for parsing custom type in form data.

type Range 

type Range struct {
	Type   string
	Ranges []RangeSet
}

Range data for c.Range

type RangeSet added in v2.51.0 

type RangeSet struct {
	Start int
	End   int
}

RangeSet represents a single content range from a request.

type Request added in v2.6.0 

type Request = fasthttp.Request

Request represents HTTP request.

It is forbidden copying Request instances. Create new instances and use CopyTo instead.

Request instance MUST NOT be used from concurrently running goroutines. Copy from fasthttp

type Response added in v2.6.0 

type Response = fasthttp.Response

Response represents HTTP response.

It is forbidden copying Response instances. Create new instances and use CopyTo instead.

Response instance MUST NOT be used from concurrently running goroutines. Copy from fasthttp

func AcquireResponse added in v2.6.0 

func AcquireResponse() *Response

AcquireResponse returns an empty Response instance from response pool.

The returned Response instance may be passed to ReleaseResponse when it is no longer needed. This allows Response recycling, reduces GC pressure and usually improves performance. Copy from fasthttp

type RetryIfFunc added in v2.26.0 

type RetryIfFunc = fasthttp.RetryIfFunc

RetryIfFunc signature of retry if function Request argument passed to RetryIfFunc, if there are any request errors. Copy from fasthttp

type Route 

type Route struct {

	// Public fields
	Method string `json:"method"` // HTTP method
	Name   string `json:"name"`   // Route's name
	//nolint:revive // Having both a Path (uppercase) and a path (lowercase) is fine
	Path     string    `json:"path"`   // Original registered route path
	Params   []string  `json:"params"` // Case sensitive param keys
	Handlers []Handler `json:"-"`      // Ctx handlers
	// contains filtered or unexported fields
}

Route is a struct that holds all metadata for each registered handler.

type RouteMessage added in v2.24.0 

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

RouteMessage is some message need to be print when server starts

type Router 

type Router interface {
	Use(args ...interface{}) Router

	Get(path string, handlers ...Handler) Router
	Head(path string, handlers ...Handler) Router
	Post(path string, handlers ...Handler) Router
	Put(path string, handlers ...Handler) Router
	Delete(path string, handlers ...Handler) Router
	Connect(path string, handlers ...Handler) Router
	Options(path string, handlers ...Handler) Router
	Trace(path string, handlers ...Handler) Router
	Patch(path string, handlers ...Handler) Router

	Add(method, path string, handlers ...Handler) Router
	Static(prefix, root string, config ...Static) Router
	All(path string, handlers ...Handler) Router

	Group(prefix string, handlers ...Handler) Router

	Route(prefix string, fn func(router Router), name ...string) Router

	Mount(prefix string, fiber *App) Router

	Name(name string) Router
}

Router defines all router handle interface, including app and group router.

type Static 

type Static struct {
	// When set to true, the server tries minimizing CPU usage by caching compressed files.
	// This works differently than the github.com/gofiber/compression middleware.
	// Optional. Default value false
	Compress bool `json:"compress"`

	// When set to true, enables byte range requests.
	// Optional. Default value false
	ByteRange bool `json:"byte_range"`

	// When set to true, enables directory browsing.
	// Optional. Default value false.
	Browse bool `json:"browse"`

	// When set to true, enables direct download.
	// Optional. Default value false.
	Download bool `json:"download"`

	// The name of the index file for serving a directory.
	// Optional. Default value "index.html".
	Index string `json:"index"`

	// Expiration duration for inactive file handlers.
	// Use a negative time.Duration to disable it.
	//
	// Optional. Default value 10 * time.Second.
	CacheDuration time.Duration `json:"cache_duration"`

	// The value for the Cache-Control HTTP-header
	// that is set on the file response. MaxAge is defined in seconds.
	//
	// Optional. Default value 0.
	MaxAge int `json:"max_age"`

	// ModifyResponse defines a function that allows you to alter the response.
	//
	// Optional. Default: nil
	ModifyResponse Handler

	// Next defines a function to skip this middleware when returned true.
	//
	// Optional. Default: nil
	Next func(c *Ctx) bool
}

Static defines configuration options when defining static assets.

type Storage added in v2.1.2 

type Storage interface {
	// Get gets the value for the given key.
	// `nil, nil` is returned when the key does not exist
	Get(key string) ([]byte, error)

	// Set stores the given value for the given key along
	// with an expiration value, 0 means no expiration.
	// Empty key or value will be ignored without an error.
	Set(key string, val []byte, exp time.Duration) error

	// Delete deletes the value for the given key.
	// It returns no error if the storage does not contain the key,
	Delete(key string) error

	// Reset resets the storage and delete all keys.
	Reset() error

	// Close closes the storage and will stop any running garbage
	// collectors and open connections.
	Close() error
}

Storage interface for communicating with different database/key-value providers

type SyntaxError added in v2.27.0 

type SyntaxError = errors.SyntaxError

A SyntaxError is a description of a JSON syntax error.

type TLSHandler added in v2.37.0 

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

TLSHandler object

func (*TLSHandler) GetClientInfo added in v2.37.0 

func (t *TLSHandler) GetClientInfo(info *tls.ClientHelloInfo) (*tls.Certificate, error)

GetClientInfo Callback function to set ClientHelloInfo Must comply with the method structure of https://cs.opensource.google/go/go/+/refs/tags/go1.20:src/crypto/tls/common.go;l=554-563 Since we overlay the method of the tls config in the listener method

type TypeConstraint added in v2.37.0 

type TypeConstraint int16

TypeConstraint parameter constraint types

type UnknownKeyError added in v2.13.0 

type UnknownKeyError = schema.UnknownKeyError

UnknownKeyError error exposes the internal schema.UnknownKeyError for public use.

type UnmarshalTypeError added in v2.27.0 

type UnmarshalTypeError = errors.UnmarshalTypeError

An UnmarshalTypeError describes a JSON value that was not appropriate for a value of a specific Go type.

type UnsupportedTypeError added in v2.27.0 

type UnsupportedTypeError = errors.UnsupportedTypeError

An UnsupportedTypeError is returned by Marshal when attempting to encode an unsupported value type.

type UnsupportedValueError added in v2.27.0 

type UnsupportedValueError = errors.UnsupportedValueError

type Views 

type Views interface {
	Load() error
	Render(io.Writer, string, interface{}, ...string) error
}

Views is the interface that wraps the Render function.

Source Files

View all Source files

Directories

Path Synopsis
internal
go-ole
go-ole/oleutil
gopsutil/common
gopsutil/cpu
gopsutil/load
gopsutil/mem
gopsutil/net
gopsutil/process
memory
Package memory Is a slight copy of the memory storage, but far from the storage interface it can not only work with bytes but directly store any kind of data without having to encode it each time, which gives a huge speed advantage
 Package memory Is a slight copy of the memory storage, but far from the storage interface it can not only work with bytes but directly store any kind of data without having to encode it each time, which gives a huge speed advantage
schema
Package gorilla/schema fills a struct with form values.
 Package gorilla/schema fills a struct with form values.
storage/memory
Package memory Is a copy of the storage memory from the external storage packet as a purpose to test the behavior in the unittests when using a storages from these packets
 Package memory Is a copy of the storage memory from the external storage packet as a purpose to test the behavior in the unittests when using a storages from these packets
template/html
template/utils
tlstest
wmi
Package wmi provides a WQL interface for WMI on Windows.
 Package wmi provides a WQL interface for WMI on Windows.
middleware
adaptor
basicauth
cache
Special thanks to @codemicro for moving this to fiber core Original middleware: github.com/codemicro/fiber-cache
 Special thanks to @codemicro for moving this to fiber core Original middleware: github.com/codemicro/fiber-cache
compress
cors
csrf
earlydata
encryptcookie
envvar
etag
expvar
favicon
filesystem
healthcheck
helmet
idempotency
keyauth
Special thanks to Echo: https://github.com/labstack/echo/blob/master/middleware/key_auth.go
 Special thanks to Echo: https://github.com/labstack/echo/blob/master/middleware/key_auth.go
limiter
logger
monitor
pprof
proxy
recover
redirect
requestid
rewrite
session
skip
timeout

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.