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(methods []string, path string, handler Handler, middleware ...Handler) Router

Add allows you to specify multiple HTTP methods to register a route.

func (*App) All ¶

func (app *App) All(path string, handler Handler, middleware ...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, handler Handler, middleware ...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, handler Handler, middleware ...Handler) Router

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

func (*App) ErrorHandler ¶

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, handler Handler, middleware ...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 ¶

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

GetRoute Get route by name

func (*App) GetRoutes ¶

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 ¶

func (app *App) HandlersCount() uint32

HandlersCount returns the amount of registered handlers.

func (*App) Head ¶

func (app *App) Head(path string, handler Handler, middleware ...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 ¶

func (app *App) Hooks() *Hooks

Hooks returns the hook struct to register hooks.

func (*App) Listen ¶

func (app *App) Listen(addr string, config ...ListenConfig) error

Listen serves HTTP requests from the given addr. You should enter custom ListenConfig to customize startup. (TLS, mTLS, prefork...)

app.Listen(":8080")
app.Listen("127.0.0.1:8080")
app.Listen(":8080", ListenConfig{EnablePrefork: true})

func (*App) Listener ¶

func (app *App) Listener(ln net.Listener, config ...ListenConfig) error

Listener serves HTTP requests from the given listener. You should enter custom ListenConfig to customize startup. (prefork, startup message, graceful shutdown...)

func (*App) MountPath ¶

func (app *App) MountPath() string

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

func (*App) Name ¶

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

Name Assign name to specific route.

func (*App) NewCtxFunc ¶

func (app *App) NewCtxFunc(function func(app *App) CustomCtx)

NewCtxFunc allows to customize ctx methods as we want. Note: It doesn't allow adding new methods, only customizing exist methods.

func (*App) Options ¶

func (app *App) Options(path string, handler Handler, middleware ...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, handler Handler, middleware ...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, handler Handler, middleware ...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, handler Handler, middleware ...Handler) Router

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

func (*App) RegisterCustomBinder ¶

func (app *App) RegisterCustomBinder(binder CustomBinder)

You can register custom binders to use as Bind().Custom("name"). They should be compatible with CustomBinder interface.

func (*App) RegisterCustomConstraint ¶

func (app *App) RegisterCustomConstraint(constraint CustomConstraint)

RegisterCustomConstraint allows to register custom constraint.

func (*App) ReleaseCtx ¶

func (app *App) ReleaseCtx(c Ctx)

ReleaseCtx releases the ctx back into the pool.

func (*App) Route ¶

func (app *App) Route(path string) Register

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 ¶

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

Server returns the underlying fasthttp server

func (*App) SetTLSHandler ¶

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

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 ¶

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 ¶

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, timeout ...time.Duration) (*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, handler Handler, middleware ...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 ...any) Router

Use registers a middleware route that will match requests with the provided prefix (which is optional and defaults to "/"). Also, you can pass 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 Use. 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.

	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()
	})
 	subApp := fiber.New()
	app.Use("/mounted-path", subApp)

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

func (*Bind) Body ¶

func (b *Bind) Body(out any) error

Body binds the request body into the struct, map[string]string and map[string][]string. 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 If none of the content types above are matched, it'll take a look custom binders by checking the MIMETypes() method of custom binder. If there're no custom binder for mşme type of body, it will return a ErrUnprocessableEntity error.

func (*Bind) Cookie ¶

func (b *Bind) Cookie(out any) error

Cookie binds the requesr cookie strings into the struct, map[string]string and map[string][]string. NOTE: If your cookie is like key=val1,val2; they'll be binded as an slice if your map is map[string][]string. Else, it'll use last element of cookie.

func (*Bind) Custom ¶

func (b *Bind) Custom(name string, dest any) error

To use custom binders, you have to use this method. You can register them from RegisterCustomBinder method of Fiber instance. They're checked by name, if it's not found, it will return an error. NOTE: Should/Must is still valid for Custom binders.

func (*Bind) Form ¶

func (b *Bind) Form(out any) error

Form binds the form into the struct, map[string]string and map[string][]string.

func (*Bind) Header ¶

func (b *Bind) Header(out any) error

Header binds the request header strings into the struct, map[string]string and map[string][]string.

func (*Bind) JSON ¶

func (b *Bind) JSON(out any) error

JSON binds the body string into the struct.

func (*Bind) MultipartForm ¶

func (b *Bind) MultipartForm(out any) error

MultipartForm binds the multipart form into the struct, map[string]string and map[string][]string.

func (*Bind) Must ¶

func (b *Bind) Must() *Bind

If you want to handle binder errors automatically, you can use Must. If there's an error it'll return error and 400 as HTTP status.

func (*Bind) Query ¶

func (b *Bind) Query(out any) error

QueryParser binds the query string into the struct, map[string]string and map[string][]string.

func (*Bind) RespHeader ¶

func (b *Bind) RespHeader(out any) error

RespHeader binds the response header strings into the struct, map[string]string and map[string][]string.

func (*Bind) Should ¶

func (b *Bind) Should() *Bind

To handle binder errors manually, you can prefer Should method. It's default behavior of binder.

func (*Bind) URI ¶

func (b *Bind) URI(out any) error

URI binds the route parameters into the struct, map[string]string and map[string][]string.

func (*Bind) XML ¶

func (b *Bind) XML(out any) error

XML binds the body string into the struct.

func (*Constraint) CheckConstraint ¶

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

func (*DefaultCtx) Accepts ¶

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

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

func (*DefaultCtx) AcceptsCharsets ¶

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

AcceptsCharsets checks if the specified charset is acceptable.

func (*DefaultCtx) AcceptsEncodings ¶

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

AcceptsEncodings checks if the specified encoding is acceptable.

func (*DefaultCtx) AcceptsLanguages ¶

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

AcceptsLanguages checks if the specified language is acceptable.

func (*DefaultCtx) App ¶

func (c *DefaultCtx) App() *App

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

func (*DefaultCtx) Append ¶

func (c *DefaultCtx) 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 (*DefaultCtx) Attachment ¶

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

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

func (*DefaultCtx) AutoFormat ¶

func (c *DefaultCtx) AutoFormat(body any) error

AutoFormat performs content-negotiation on the Accept HTTP header. It uses Accepts to select a proper format. The supported content types are text/html, text/plain, application/json, and application/xml. For more flexible content negotiation, use Format. If the header is not specified or there is no proper format, text/plain is used.

func (*DefaultCtx) BaseURL ¶

func (c *DefaultCtx) BaseURL() string

BaseURL returns (protocol + host + base path).

func (*DefaultCtx) Bind ¶

func (c *DefaultCtx) Bind() *Bind

You can bind body, cookie, headers etc. into the map, map slice, struct easily by using Binding method. It gives custom binding support, detailed binding options and more. Replacement of: BodyParser, ParamsParser, GetReqHeaders, GetRespHeaders, AllParams, QueryParser, ReqHeaderParser

func (*DefaultCtx) BindVars ¶

func (c *DefaultCtx) BindVars(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 (*DefaultCtx) Body ¶

func (c *DefaultCtx) 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 (*DefaultCtx) BodyRaw ¶

func (c *DefaultCtx) 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 (*DefaultCtx) ClearCookie ¶

func (c *DefaultCtx) 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 (*DefaultCtx) ClientHelloInfo ¶

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

ClientHelloInfo return CHI from context

func (*DefaultCtx) Context ¶

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

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

func (*DefaultCtx) Cookie ¶

func (c *DefaultCtx) Cookie(cookie *Cookie)

Cookie sets a cookie by passing a cookie struct.

func (*DefaultCtx) Cookies ¶

func (c *DefaultCtx) 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 (*DefaultCtx) Download ¶

func (c *DefaultCtx) 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 (*DefaultCtx) FormFile ¶

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

FormFile returns the first file by key from a MultipartForm.

func (*DefaultCtx) FormValue ¶

func (c *DefaultCtx) 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 (*DefaultCtx) Format ¶

func (c *DefaultCtx) Format(handlers ...ResFmt) error

Format performs content-negotiation on the Accept HTTP header. It uses Accepts to select a proper format and calls the matching user-provided handler function. If no accepted format is found, and a format with MediaType "default" is given, that default handler is called. If no format is found and no default is given, StatusNotAcceptable is sent.

func (*DefaultCtx) Fresh ¶

func (c *DefaultCtx) 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 (*DefaultCtx) Get ¶

func (c *DefaultCtx) 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 (*DefaultCtx) GetReqHeaders ¶

func (c *DefaultCtx) 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 (*DefaultCtx) GetRespHeader ¶

func (c *DefaultCtx) 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 (*DefaultCtx) GetRespHeaders ¶

func (c *DefaultCtx) 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 (*DefaultCtx) GetRouteURL ¶

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

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

func (*DefaultCtx) Host ¶

func (c *DefaultCtx) Host() string

Host contains the host 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 (*DefaultCtx) Hostname ¶

func (c *DefaultCtx) Hostname() string

Hostname contains the hostname derived from the X-Forwarded-Host or Host HTTP header using the c.Host() method. 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 (*DefaultCtx) IP ¶

func (c *DefaultCtx) 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 (*DefaultCtx) IPs ¶

func (c *DefaultCtx) 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 (*DefaultCtx) Is ¶

func (c *DefaultCtx) 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 (*DefaultCtx) IsFromLocal ¶

func (c *DefaultCtx) IsFromLocal() bool

IsFromLocal will return true if request came from local.

func (*DefaultCtx) IsProxyTrusted ¶

func (c *DefaultCtx) IsProxyTrusted() bool

IsProxyTrusted checks trustworthiness of remote ip. If EnableTrustedProxyCheck false, it returns true IsProxyTrusted can check remote ip by proxy ranges and ip map.

func (*DefaultCtx) JSON ¶

func (c *DefaultCtx) JSON(data any, 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 (*DefaultCtx) JSONP ¶

func (c *DefaultCtx) JSONP(data any, 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 (*DefaultCtx) Links ¶

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

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

func (*DefaultCtx) Locals ¶

func (c *DefaultCtx) Locals(key any, value ...any) any

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

func (*DefaultCtx) Location ¶

func (c *DefaultCtx) Location(path string)

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

func (*DefaultCtx) Method ¶

func (c *DefaultCtx) 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 (*DefaultCtx) MultipartForm ¶

func (c *DefaultCtx) 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 (*DefaultCtx) Next ¶

func (c *DefaultCtx) Next() error

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

func (*DefaultCtx) OriginalURL ¶

func (c *DefaultCtx) 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 (*DefaultCtx) Params ¶

func (c *DefaultCtx) 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 (*DefaultCtx) Path ¶

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

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

func (*DefaultCtx) Port ¶

func (c *DefaultCtx) Port() string

Port returns the remote port of the request.

func (*DefaultCtx) Protocol ¶

func (c *DefaultCtx) Protocol() string

Protocol returns the HTTP protocol of request: HTTP/1.1 and HTTP/2.

func (*DefaultCtx) Queries ¶

func (c *DefaultCtx) 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 (*DefaultCtx) Query ¶

func (c *DefaultCtx) 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 (*DefaultCtx) Range ¶

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

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

func (*DefaultCtx) Redirect ¶

func (c *DefaultCtx) Redirect() *Redirect

Redirect returns the Redirect reference. Use Redirect().Status() to set custom redirection status code. If status is not specified, status defaults to 302 Found. You can use Redirect().To(), Redirect().Route() and Redirect().Back() for redirection.

func (*DefaultCtx) Render ¶

func (c *DefaultCtx) Render(name string, bind Map, layouts ...string) error

Render a template with data and sends a text/html response. We support the following engines: https://github.com/gofiber/template

func (*DefaultCtx) Request ¶

func (c *DefaultCtx) 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 (*DefaultCtx) Reset ¶

func (c *DefaultCtx) Reset(fctx *fasthttp.RequestCtx)

Reset is a method to reset context fields by given request when to use server handlers.

func (*DefaultCtx) Response ¶

func (c *DefaultCtx) 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 (*DefaultCtx) RestartRouting ¶

func (c *DefaultCtx) 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 (*DefaultCtx) Route ¶

func (c *DefaultCtx) Route() *Route

Route returns the matched Route struct.

func (*DefaultCtx) SaveFile ¶

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

SaveFile saves any multipart file to disk.

func (*DefaultCtx) SaveFileToStorage ¶

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

SaveFileToStorage saves any multipart file to an external storage system.

func (*DefaultCtx) Scheme ¶

func (c *DefaultCtx) Scheme() string

Scheme 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 (*DefaultCtx) Secure ¶

func (c *DefaultCtx) Secure() bool

Secure returns whether a secure connection was established.

func (*DefaultCtx) Send ¶

func (c *DefaultCtx) 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 (*DefaultCtx) SendFile ¶

func (c *DefaultCtx) 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 (*DefaultCtx) SendStatus ¶

func (c *DefaultCtx) 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 (*DefaultCtx) SendStream ¶

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

SendStream sets response body stream and optional body size.

func (*DefaultCtx) SendString ¶

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

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

func (*DefaultCtx) Set ¶

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

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

func (*DefaultCtx) SetUserContext ¶

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

SetUserContext sets a context implementation by user.

func (*DefaultCtx) Stale ¶

func (c *DefaultCtx) Stale() bool

Stale is not implemented yet, pull requests are welcome!

func (*DefaultCtx) Status ¶

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

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

func (*DefaultCtx) String ¶

func (c *DefaultCtx) String() string

String returns unique string representation of the ctx.

The returned value may be useful for logging.

func (*DefaultCtx) Subdomains ¶

func (c *DefaultCtx) 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 (*DefaultCtx) Type ¶

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

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

func (*DefaultCtx) UserContext ¶

func (c *DefaultCtx) 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 (*DefaultCtx) Vary ¶

func (c *DefaultCtx) 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 (*DefaultCtx) Write ¶

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

Write appends p into response body.

func (*DefaultCtx) WriteString ¶

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

WriteString appends s to response body.

func (*DefaultCtx) Writef ¶

func (c *DefaultCtx) Writef(f string, a ...any) (int, error)

Writef appends f & a into response body writer.

func (*DefaultCtx) XHR ¶

func (c *DefaultCtx) 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 (*DefaultCtx) XML ¶

func (c *DefaultCtx) XML(data any) error

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

func (*Error) Error ¶

func (e *Error) Error() string

Error makes it compatible with the `error` interface.

func (*Group) Add ¶

func (grp *Group) Add(methods []string, path string, handler Handler, middleware ...Handler) Router

Add allows you to specify multiple HTTP methods to register a route.

func (*Group) All ¶

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

All will register the handler on all HTTP methods

func (*Group) Connect ¶

func (grp *Group) Connect(path string, handler Handler, middleware ...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, handler Handler, middleware ...Handler) Router

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

func (*Group) Get ¶

func (grp *Group) Get(path string, handler Handler, middleware ...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, handler Handler, middleware ...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) Name ¶

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, handler Handler, middleware ...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, handler Handler, middleware ...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, handler Handler, middleware ...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, handler Handler, middleware ...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 ¶

func (grp *Group) Route(path string) Register

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, handler Handler, middleware ...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 ...any) Router

Use registers a middleware route that will match requests with the provided prefix (which is optional and defaults to "/"). Also, you can pass 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 Use. 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.

	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()
	})
 	subApp := fiber.New()
	app.Use("/mounted-path", subApp)

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

func (*Hooks) OnFork ¶

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

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

func (*Hooks) OnGroup ¶

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 ¶

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 ¶

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

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

func (*Hooks) OnMount ¶

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 ¶

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 ¶

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 ¶

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

OnShutdown is a hook to execute user functions after Shutdown.

func (*Redirect) Back ¶

func (r *Redirect) Back(fallback ...string) error

Redirect back to the URL to referer.

func (*Redirect) Message ¶

func (r *Redirect) Message(key string) string

Get flash message by key.

func (*Redirect) Messages ¶

func (r *Redirect) Messages() map[string]string

Get flash messages.

func (*Redirect) OldInput ¶

func (r *Redirect) OldInput(key string) string

Get old input data by key.

func (*Redirect) OldInputs ¶

func (r *Redirect) OldInputs() map[string]string

Get old input data.

func (*Redirect) Route ¶

func (r *Redirect) Route(name string, config ...RedirectConfig) error

Route redirects to the Route registered in the app with appropriate parameters. If you want to send queries or params to route, you should use config parameter.

func (*Redirect) Status ¶

func (r *Redirect) Status(code int) *Redirect

Status sets the status code of redirection. If status is not specified, status defaults to 302 Found.

func (*Redirect) To ¶

func (r *Redirect) To(location string) error

Redirect to the URL derived from the specified path, with specified status.

func (*Redirect) With ¶

func (r *Redirect) With(key, value string) *Redirect

You can send flash messages by using With(). They will be sent as a cookie. You can get them by using: Redirect().Messages(), Redirect().Message() Note: You must use escape char before using ',' and ':' chars to avoid wrong parsing.

func (*Redirect) WithInput ¶

func (r *Redirect) WithInput() *Redirect

You can send input data by using WithInput(). They will be sent as a cookie. This method can send form, multipart form, query data to redirected route. You can get them by using: Redirect().OldInputs(), Redirect().OldInput()

func (*Registering) Add ¶

func (r *Registering) Add(methods []string, handler Handler, middleware ...Handler) Register

Add allows you to specify multiple HTTP methods to register a route.

func (*Registering) All ¶

func (r *Registering) All(handler Handler, middleware ...Handler) Register

All registers a middleware route that will match requests with the provided path which is stored in register struct.

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

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

func (*Registering) Connect ¶

func (r *Registering) Connect(handler Handler, middleware ...Handler) Register

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

func (*Registering) Delete ¶

func (r *Registering) Delete(handler Handler, middleware ...Handler) Register

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

func (*Registering) Get ¶

func (r *Registering) Get(handler Handler, middleware ...Handler) Register

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

func (*Registering) Head ¶

func (r *Registering) Head(handler Handler, middleware ...Handler) Register

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 (*Registering) Options ¶

func (r *Registering) Options(handler Handler, middleware ...Handler) Register

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

func (*Registering) Patch ¶

func (r *Registering) Patch(handler Handler, middleware ...Handler) Register

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

func (*Registering) Post ¶

func (r *Registering) Post(handler Handler, middleware ...Handler) Register

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 (*Registering) Put ¶

func (r *Registering) Put(handler Handler, middleware ...Handler) Register

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

func (*Registering) Route ¶

func (r *Registering) Route(path string) Register

Route returns a new Register instance whose route path takes the path in the current instance as its prefix.

func (*Registering) Static ¶

func (r *Registering) Static(root string, config ...Static) Register

Static will create a file server serving static files

func (*Registering) Trace ¶

func (r *Registering) Trace(handler Handler, middleware ...Handler) Register

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

func (*TLSHandler) GetClientInfo ¶

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