description: >- The Ctx struct 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.

🧠 Context

Accepts

Checks, if the specified extensions or content types are acceptable.

Based on the request’s Accept HTTP header. 

  1. func (c *Ctx) Accepts(offers ...string)          string
  2. func (c *Ctx) AcceptsCharsets(offers ...string)  string
  3. func (c *Ctx) AcceptsEncodings(offers ...string) string
  4. func (c *Ctx) AcceptsLanguages(offers ...string) string
  1. // Accept: text/*, application/json
  3. app.Get("/", func(c *fiber.Ctx) error {
  4.   c.Accepts("html")             // "html"
  5.   c.Accepts("text/html")        // "text/html"
  6.   c.Accepts("json", "text")     // "json"
  7.   c.Accepts("application/json") // "application/json"
  8.   c.Accepts("image/png")        // ""
  9.   c.Accepts("png")              // ""
  10.   // ...
  11. })

Fiber provides similar functions for the other accept headers.

  1. // Accept-Charset: utf-8, iso-8859-1;q=0.2
  2. // Accept-Encoding: gzip, compress;q=0.2
  3. // Accept-Language: en;q=0.8, nl, ru
  5. app.Get("/", func(c *fiber.Ctx) error {
  6.   c.AcceptsCharsets("utf-16", "iso-8859-1") 
  7.   // "iso-8859-1"
  9.   c.AcceptsEncodings("compress", "br") 
  10.   // "compress"
  12.   c.AcceptsLanguages("pt", "nl", "ru") 
  13.   // "nl"
  14.   // ...
  15. })

Append

Appends the specified value to the HTTP response header field.

If the header is not already set, it creates the header with the specified value. 

  1. func (c *Ctx) Append(field string, values ...string)
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   c.Append("Link", "http://google.com", "http://localhost")
  3.   // => Link: http://localhost, http://google.com
  5.   c.Append("Link", "Test")
  6.   // => Link: http://localhost, http://google.com, Test
  8.   // ...
  9. })

Attachment

Sets the HTTP response Content-Disposition header field to attachment.

  1. func (c *Ctx) Attachment(filename ...string)
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   c.Attachment()
  3.   // => Content-Disposition: attachment
  5.   c.Attachment("./upload/images/logo.png")
  6.   // => Content-Disposition: attachment; filename="logo.png"
  7.   // => Content-Type: image/png
  9.   // ...
  10. })

App

Returns the *App reference so you could easily access all application settings.

  1. func (c *Ctx) App() *App
  1. app.Get("/stack", func(c *fiber.Ctx) error {
  2.   return c.JSON(c.App().Stack())
  3. })

BaseURL

Returns the base URL (protocol + host) as a string.

  1. func (c *Ctx) BaseURL() string
  1. // GET https://example.com/page#chapter-1
  3. app.Get("/", func(c *fiber.Ctx) error {
  4.   c.BaseURL() // https://example.com
  5.   // ...
  6. })

Body

Returns the raw request body.

  1. func (c *Ctx) Body() []byte
  1. // curl -X POST http://localhost:8080 -d user=john
  3. app.Post("/", func(c *fiber.Ctx) error {
  4.   // Get raw body from POST request:
  5.   return c.Send(c.Body()) // []byte("user=john")
  6. })

Returned value is only valid within the handler. Do not store any references.
Make copies or use the Immutable setting instead. Read more…

BodyParser

Binds the request body to a struct. BodyParser supports decoding query parameters and the following content types based on the Content-Type header:

  • application/json
  • application/xml
  • application/x-www-form-urlencoded
  • multipart/form-data
  1. func (c *Ctx) BodyParser(out interface{}) error
  1. // Field names should start with an uppercase letter
  2. type Person struct {
  3.     Name string `json:"name" xml:"name" form:"name"`
  4.     Pass string `json:"pass" xml:"pass" form:"pass"`
  5. }
  7. app.Post("/", func(c *fiber.Ctx) error {
  8.         p := new(Person)
  10.         if err := c.BodyParser(p); err != nil {
  11.             return err
  12.         }
  14.         log.Println(p.Name) // john
  15.         log.Println(p.Pass) // doe
  17.         // ...
  18. })
  20. // Run tests with the following curl commands
  22. // curl -X POST -H "Content-Type: application/json" --data "{\"name\":\"john\",\"pass\":\"doe\"}" localhost:3000
  24. // curl -X POST -H "Content-Type: application/xml" --data "<login><name>john</name><pass>doe</pass></login>" localhost:3000
  26. // curl -X POST -H "Content-Type: application/x-www-form-urlencoded" --data "name=john&pass=doe" localhost:3000
  28. // curl -X POST -F name=john -F pass=doe http://localhost:3000
  30. // curl -X POST "http://localhost:3000/?name=john&pass=doe"

ClearCookie

Expire a client cookie (or all cookies if left empty)

  1. func (c *Ctx) ClearCookie(key ...string)
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   // Clears all cookies:
  3.   c.ClearCookie()
  5.   // Expire specific cookie by name:
  6.   c.ClearCookie("user")
  8.   // Expire multiple cookies by names:
  9.   c.ClearCookie("token", "session", "track_id", "version")
  10.   // ...
  11. })

Web browsers and other compliant clients will only clear the cookie if the given options are identical to those when creating the cookie, excluding expires and maxAge. ClearCookie will not set these values for you - a technique similar to the one shown below should be used to ensure your cookie is deleted. 

  1. app.Get("/set", func(c *fiber.Ctx) error {
  2.     c.Cookie(&fiber.Cookie{
  3.         Name:     "token",
  4.         Value:    "randomvalue",
  5.         Expires:  time.Now().Add(24 * time.Hour),
  6.         HTTPOnly: true,
  7.         SameSite: "lax",
  8.     })
  10.     // ...
  11. })
  13. app.Get("/delete", func(c *fiber.Ctx) error {
  14.     c.Cookie(&fiber.Cookie{
  15.         Name:     "token",
  16.         // Set expiry date to the past
  17.         Expires:  time.Now().Add(-(time.Hour * 2)),
  18.         HTTPOnly: true,
  19.         SameSite: "lax",
  20.     })
  22.     // ...
  23. })

Context

Returns *fasthttp.RequestCtx that is compatible with the context.Context interface that requires a deadline, a cancellation signal, and other values across API boundaries.

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

Please read the Fasthttp Documentation for more information.

Cookie

Set cookie

  1. func (c *Ctx) Cookie(cookie *Cookie)
  1. type Cookie struct {
  2.     Name     string    `json:"name"`
  3.     Value    string    `json:"value"`
  4.     Path     string    `json:"path"`
  5.     Domain   string    `json:"domain"`
  6.     MaxAge   int       `json:"max_age"`
  7.     Expires  time.Time `json:"expires"`
  8.     Secure   bool      `json:"secure"`
  9.     HTTPOnly bool      `json:"http_only"`
  10.     SameSite string    `json:"same_site"`
  11. }
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   // Create cookie
  3.   cookie := new(fiber.Cookie)
  4.   cookie.Name = "john"
  5.   cookie.Value = "doe"
  6.   cookie.Expires = time.Now().Add(24 * time.Hour)
  8.   // Set cookie
  9.   c.Cookie(cookie)
  10.   // ...
  11. })

Cookies

Get cookie value by key, you could pass an optional default value that will be returned if the cookie key does not exist.

Signatures

  1. func (c *Ctx) Cookies(key string, defaultValue ...string) string
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   // Get cookie by key:
  3.   c.Cookies("name")         // "john"
  4.   c.Cookies("empty", "doe") // "doe"
  5.   // ...
  6. })

Returned value is only valid within the handler. Do not store any references.
Make copies or use the Immutable setting instead. Read more…

Download

Transfers the file from path as an attachment.

Typically, browsers will prompt the user to download. By default, the Content-Disposition header filename= parameter is the file path (this typically appears in the browser dialog).

Override this default with the filename parameter.

  1. func (c *Ctx) Download(file string, filename ...string) error
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   return c.Download("./files/report-12345.pdf");
  3.   // => Download report-12345.pdf
  5.   return c.Download("./files/report-12345.pdf", "report.pdf");
  6.   // => Download report.pdf
  7. })

Request

Request return the *fasthttp.Request pointer

Signature

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

Example

  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   c.Request().Header.Method()
  3.   // => []byte("GET")
  4. })

Response

Request return the *fasthttp.Response pointer

Signature

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

Example

  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   c.Response().Write([]byte("Hello, World!"))
  3.   // => "Hello, World!"
  4. })

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. 

  1. func (c *Ctx) Format(body interface{}) error
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   // Accept: text/plain
  3.   c.Format("Hello, World!")
  4.   // => Hello, World!
  6.   // Accept: text/html
  7.   c.Format("Hello, World!")
  8.   // => <p>Hello, World!</p>
  10.   // Accept: application/json
  11.   c.Format("Hello, World!")
  12.   // => "Hello, World!"
  13.   // ..
  14. })

FormFile

MultipartForm files can be retrieved by name, the first file from the given key is returned.

  1. func (c *Ctx) FormFile(key string) (*multipart.FileHeader, error)
  1. app.Post("/", func(c *fiber.Ctx) error {
  2.   // Get first file from form field "document":
  3.   file, err := c.FormFile("document")
  5.   // Save file to root directory:
  6.   return c.SaveFile(file, fmt.Sprintf("./%s", file.Filename))
  7. })

FormValue

Any form values can be retrieved by name, the first value from the given key is returned.

  1. func (c *Ctx) FormValue(key string, defaultValue ...string) string
  1. app.Post("/", func(c *fiber.Ctx) error {
  2.   // Get first value from form field "name":
  3.   c.FormValue("name")
  4.   // => "john" or "" if not exist
  6.   // ..
  7. })

Returned value is only valid within the handler. Do not store any references.
Make copies or use the Immutable setting instead. Read more…

Fresh

https://expressjs.com/en/4x/api.html#req.fresh

  1. func (c *Ctx) Fresh() bool

Get

Returns the HTTP request header specified by the field.

The match is case-insensitive. 

  1. func (c *Ctx) Get(key string, defaultValue ...string) string
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   c.Get("Content-Type")       // "text/plain"
  3.   c.Get("CoNtEnT-TypE")       // "text/plain"
  4.   c.Get("something", "john")  // "john"
  5.   // ..
  6. })

Returned value is only valid within the handler. Do not store any references.
Make copies or use the Immutable setting instead. Read more…

Hostname

Returns the hostname derived from the Host HTTP header.

  1. func (c *Ctx) Hostname() string
  1. // GET http://google.com/search
  3. app.Get("/", func(c *fiber.Ctx) error {
  4.   c.Hostname() // "google.com"
  6.   // ...
  7. })

Returned value is only valid within the handler. Do not store any references.
Make copies or use the Immutable setting instead. Read more…

IP

Returns the remote IP address of the request.

  1. func (c *Ctx) IP() string
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   c.IP() // "127.0.0.1"
  4.   // ...
  5. })

IPs

Returns an array of IP addresses specified in the X-Forwarded-For request header.

  1. func (c *Ctx) IPs() []string
  1. // X-Forwarded-For: proxy1, 127.0.0.1, proxy3
  3. app.Get("/", func(c *fiber.Ctx) error {
  4.   c.IPs() // ["proxy1", "127.0.0.1", "proxy3"]
  6.   // ...
  7. })

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.

If the request has no body, it returns false. 

  1. func (c *Ctx) Is(extension string) bool
  1. // Content-Type: text/html; charset=utf-8
  3. app.Get("/", func(c *fiber.Ctx) error {
  4.   c.Is("html")  // true
  5.   c.Is(".html") // true
  6.   c.Is("json")  // false
  8.   // ...
  9. })

JSON

Converts any interface or string to JSON using the segmentio/encoding package.

JSON also sets the content header to application/json. 

  1. func (c *Ctx) JSON(data interface{}) error
  1. type SomeStruct struct {
  2.   Name string
  3.   Age  uint8
  4. }
  6. app.Get("/json", func(c *fiber.Ctx) error {
  7.   // Create data struct:
  8.   data := SomeStruct{
  9.     Name: "Grame",
  10.     Age:  20,
  11.   }
  13.   return c.JSON(data)
  14.   // => Content-Type: application/json
  15.   // => "{"Name": "Grame", "Age": 20}"
  17.   return c.JSON(fiber.Map{
  18.     "name": "Grame",
  19.     "age": 20,
  20.   })
  21.   // => Content-Type: application/json
  22.   // => "{"name": "Grame", "age": 20}"
  23. })

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.

Override this by passing a named string in the method.

  1. func (c *Ctx) JSONP(data interface{}, callback ...string) error
  1. type SomeStruct struct {
  2.   name string
  3.   age  uint8
  4. }
  6. app.Get("/", func(c *fiber.Ctx) error {
  7.   // Create data struct:
  8.   data := SomeStruct{
  9.     name: "Grame",
  10.     age:  20,
  11.   }
  13.   return c.JSONP(data)
  14.   // => callback({"name": "Grame", "age": 20})
  16.   return c.JSONP(data, "customFunc")
  17.   // => customFunc({"name": "Grame", "age": 20})
  18. })

Links

Joins the links followed by the property to populate the response’s Link HTTP header field.

  1. func (c *Ctx) Links(link ...string)
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   c.Links(
  3.     "http://api.example.com/users?page=2", "next",
  4.     "http://api.example.com/users?page=5", "last",
  5.   )
  6.   // Link: <http://api.example.com/users?page=2>; rel="next",
  7.   //       <http://api.example.com/users?page=5>; rel="last"
  9.   // ...
  10. })

Locals

A method that stores variables scoped to the request and, therefore, are available only to the routes that match the request.

This is useful if you want to pass some specific data to the next middleware. 

  1. func (c *Ctx) Locals(key string, value ...interface{}) interface{}
  1. app.Use(func(c *fiber.Ctx) error {
  2.   c.Locals("user", "admin")
  3.   return c.Next()
  4. })
  6. app.Get("/admin", func(c *fiber.Ctx) error {
  7.   if c.Locals("user") == "admin" {
  8.     return c.Status(200).SendString("Welcome, admin!")
  9.   }
  10.   return c.SendStatus(403)
  12. })

Location

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

  1. func (c *Ctx) Location(path string)
  1. app.Post("/", func(c *fiber.Ctx) error {
  2.   return c.Location("http://example.com")
  4.   return c.Location("/foo/bar")
  5. })

Method

Returns a string corresponding to the HTTP method of the request: GET, POST, PUT, and so on.
Optionally, you could override the method by passing a string.

  1. func (c *Ctx) Method(override ...string) string
  1. app.Post("/", func(c *fiber.Ctx) error {
  2.   c.Method() // "POST"
  4.   c.Method("GET")
  5.   c.Method() // GET
  7.   // ...
  8. })

MultipartForm

To access multipart form entries, you can parse the binary with MultipartForm(). This returns a map[string][]string, so given a key, the value will be a string slice.

  1. func (c *Ctx) MultipartForm() (*multipart.Form, error)
  1. app.Post("/", func(c *fiber.Ctx) error {
  2.   // Parse the multipart form:
  3.   if form, err := c.MultipartForm(); err == nil {
  4.     // => *multipart.Form
  6.     if token := form.Value["token"]; len(token) > 0 {
  7.       // Get key value:
  8.       fmt.Println(token[0])
  9.     }
  11.     // Get all files from "documents" key:
  12.     files := form.File["documents"]
  13.     // => []*multipart.FileHeader
  15.     // Loop through files:
  16.     for _, file := range files {
  17.       fmt.Println(file.Filename, file.Size, file.Header["Content-Type"][0])
  18.       // => "tutorial.pdf" 360641 "application/pdf"
  20.       // Save the files to disk:
  21.       if err := c.SaveFile(file, fmt.Sprintf("./%s", file.Filename)); err != nil {
  22.         return err
  23.       }
  24.     }
  25.   }
  27.   return err
  28. })

Next

When Next is called, it executes the next method in the stack that matches the current route. You can pass an error struct within the method that will end the chaining and call the error handler.

  1. func (c *Ctx) Next() error
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   fmt.Println("1st route!")
  3.   return c.Next()
  4. })
  6. app.Get("*", func(c *fiber.Ctx) error {
  7.   fmt.Println("2nd route!")
  8.   return c.Next()
  9. })
  11. app.Get("/", func(c *fiber.Ctx) error {
  12.   fmt.Println("3rd route!")
  13.   return c.SendString("Hello, World!")
  14. })

OriginalURL

Returns the original request URL.

  1. func (c *Ctx) OriginalURL() string
  1. // GET http://example.com/search?q=something
  3. app.Get("/", func(c *fiber.Ctx) error {
  4.   c.OriginalURL() // "/search?q=something"
  6.   // ...
  7. })

Returned value is only valid within the handler. Do not store any references.
Make copies or use the Immutable setting instead. Read more…

Params

Method can be used to get the route parameters, you could pass an optional default value that will be returned if the param key does not exist.

Defaults to empty string (""), if the param doesn’t exist. 

  1. func (c *Ctx) Params(key string, defaultValue ...string) string
  1. // GET http://example.com/user/fenny
  2. app.Get("/user/:name", func(c *fiber.Ctx) error {
  3.   c.Params("name") // "fenny"
  5.   // ...
  6. })
  8. // GET http://example.com/user/fenny/123
  9. app.Get("/user/*", func(c *fiber.Ctx) error {
  10.   c.Params("*")  // "fenny/123"
  11.   c.Params("*1") // "fenny/123"
  13.   // ...
  14. })

Unnamed route parameters(*, +) can be fetched by the character and the counter in the route.

  1. // ROUTE: /v1/*/shop/*
  2. // GET:   /v1/brand/4/shop/blue/xs
  3. c.Params("*1")  // "brand/4"
  4. c.Params("*2")  // "blue/xs"

For reasons of downward compatibility, the first parameter segment for the parameter character can also be accessed without the counter.

  1. app.Get("/v1/*/shop/*", func(c *fiber.Ctx) error {
  2.   c.Params("*") // outputs the values of the first wildcard segment
  3. })

Returned value is only valid within the handler. Do not store any references.
Make copies or use the Immutable setting instead. Read more…

ParamsInt

Method can be used to get an integer from the route parameters. Please note if that parameter is not in the request, zero will be returned. If the parameter is NOT a number, zero and an error will be returned

Defaults to empty string (""), if the param doesn’t exist. 

  1. func (c *Ctx) Params(key string) (int, error)
  1. // GET http://example.com/user/123
  2. app.Get("/user/:name", func(c *fiber.Ctx) error {
  3.   id, err := c.ParamsInt("id") // int 123 and no error
  5.   // ...
  6. })

This method is equivalent of using atoi with ctx.Params

Path

Contains the path part of the request URL. Optionally, you could override the path by passing a string.

  1. func (c *Ctx) Path(override ...string) string
  1. // GET http://example.com/users?sort=desc
  3. app.Get("/users", func(c *fiber.Ctx) error {
  4.   c.Path() // "/users"
  6.   c.Path("/john")
  7.   c.Path() // "/john"
  9.   // ...
  10. })

Protocol

Contains the request protocol string: http or https for TLS requests.

  1. func (c *Ctx) Protocol() string
  1. // GET http://example.com
  3. app.Get("/", func(c *fiber.Ctx) error {
  4.   c.Protocol() // "http"
  6.   // ...
  7. })

Query

This property is an object containing a property for each query string parameter in the route, you could pass an optional default value that will be returned if the query key does not exist.

If there is no query string, it returns an empty string. 

  1. func (c *Ctx) Query(key string, defaultValue ...string) string
  1. // GET http://example.com/shoes?order=desc&brand=nike
  3. app.Get("/", func(c *fiber.Ctx) error {
  4.   c.Query("order")         // "desc"
  5.   c.Query("brand")         // "nike"
  6.   c.Query("empty", "nike") // "nike"
  8.   // ...
  9. })

Returned value is only valid within the handler. Do not store any references.
Make copies or use the Immutable setting instead. Read more…

QueryParser

This method is similar to BodyParser, but for query parameters.

  1. func (c *Ctx) QueryParser(out interface{}) error
  1. // Field names should start with an uppercase letter
  2. type Person struct {
  3.     Name     string     `query:"name"`
  4.     Pass     string     `query:"pass"`
  5.     Products []string   `query:"products"`
  6. }
  8. app.Get("/", func(c *fiber.Ctx) error {
  9.         p := new(Person)
  11.         if err := c.QueryParser(p); err != nil {
  12.             return err
  13.         }
  15.         log.Println(p.Name)     // john
  16.         log.Println(p.Pass)     // doe
  17.         log.Println(p.Products) // [shoe, hat]
  19.         // ...
  20. })
  21. // Run tests with the following curl command
  23. // curl "http://localhost:3000/?name=john&pass=doe&products=shoe,hat"

Range

A struct containing the type and a slice of ranges will be returned.

  1. func (c *Ctx) Range(size int) (Range, error)
  1. // Range: bytes=500-700, 700-900
  2. app.Get("/", func(c *fiber.Ctx) error {
  3.   b := c.Range(1000)
  4.   if b.Type == "bytes" {
  5.       for r := range r.Ranges {
  6.       fmt.Println(r)
  7.       // [500, 700]
  8.     }
  9.   }
  10. })

Redirect

Redirects to the URL derived from the specified path, with specified status, a positive integer that corresponds to an HTTP status code.

If not specified, status defaults to 302 Found. 

  1. func (c *Ctx) Redirect(location string, status ...int) error
  1. app.Get("/coffee", func(c *fiber.Ctx) error {
  2.   return c.Redirect("/teapot")
  3. })
  5. app.Get("/teapot", func(c *fiber.Ctx) error {
  6.   return c.Status(fiber.StatusTeapot).Send("🍵 short and stout 🍵")
  7. })
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   return c.Redirect("/foo/bar")
  3.   return c.Redirect("../login")
  4.   return c.Redirect("http://example.com")
  5.   return c.Redirect("http://example.com", 301)
  6. })

Render

Renders a view with data and sends a text/html response. By default Render uses the default Go Template engine. If you want to use another View engine, please take a look at our Template middleware.

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

Route

Returns the matched Route struct.

  1. func (c *Ctx) Route() *Route
  1. // http://localhost:8080/hello
  4. app.Get("/hello/:name", func(c *fiber.Ctx) error {
  5.   r := c.Route()
  6.   fmt.Println(r.Method, r.Path, r.Params, r.Handlers)
  7.   // GET /hello/:name handler [name] 
  9.   // ...
  10. })

Do not rely on c.Route() in middlewares before calling c.Next() - c.Route() returns the last executed route. 

  1. func MyMiddleware() fiber.Handler {
  2.   return func(c *fiber.Ctx) error {
  3.     beforeNext := c.Route().Path // Will be '/'
  4.     err := c.Next()
  5.     afterNext := c.Route().Path // Will be '/hello/:name'
  6.     return err
  7.   }
  8. }

SaveFile

Method is used to save any multipart file to disk.

  1. func (c *Ctx) SaveFile(fh *multipart.FileHeader, path string) error
  1. app.Post("/", func(c *fiber.Ctx) error {
  2.   // Parse the multipart form:
  3.   if form, err := c.MultipartForm(); err == nil {
  4.     // => *multipart.Form
  6.     // Get all files from "documents" key:
  7.     files := form.File["documents"]
  8.     // => []*multipart.FileHeader
  10.     // Loop through files:
  11.     for _, file := range files {
  12.       fmt.Println(file.Filename, file.Size, file.Header["Content-Type"][0])
  13.       // => "tutorial.pdf" 360641 "application/pdf"
  15.       // Save the files to disk:
  16.       if err := c.SaveFile(file, fmt.Sprintf("./%s", file.Filename)); err != nil {
  17.         return err
  18.       }
  19.     }
  20.     return err
  21.   }
  22. })

Secure

A boolean property that is true , if a TLS connection is established.

  1. func (c *Ctx) Secure() bool
  1. // Secure() method is equivalent to:
  2. c.Protocol() == "https"

Send

Sets the HTTP response body.

  1. func (c *Ctx) Send(body []byte) error
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   return c.Send([]byte("Hello, World!")) // => "Hello, World!"
  3. })

Fiber also provides SendString and SendStream methods for raw inputs.

Use this if you don’t need type assertion, recommended for faster performance. 

  1. func (c *Ctx) SendString(body string) error
  2. func (c *Ctx) SendStream(stream io.Reader, size ...int) error
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   return c.SendString("Hello, World!")
  3.   // => "Hello, World!"
  5.   return c.SendStream(bytes.NewReader([]byte("Hello, World!")))
  6.   // => "Hello, World!"
  7. })

SendFile

Transfers the file from the given path. Sets the Content-Type response HTTP header field based on the filenames extension.

Method use gzipping by default, set it to true to disable. 

  1. func (c *Ctx) SendFile(file string, compress ...bool) error
  1. app.Get("/not-found", func(c *fiber.Ctx) error {
  2.   return c.SendFile("./public/404.html");
  4.   // Disable compression
  5.   return c.SendFile("./static/index.html", false);
  6. })

SendStatus

Sets the status code and the correct status message in the body, if the response body is empty.

You can find all used status codes and messages here. 

  1. func (c *Ctx) SendStatus(status int) error
  1. app.Get("/not-found", func(c *fiber.Ctx) error {
  2.   return c.SendStatus(415)
  3.   // => 415 "Unsupported Media Type"
  5.   c.SendString("Hello, World!")
  6.   return c.SendStatus(415)
  7.   // => 415 "Hello, World!"
  8. })

Set

Sets the response’s HTTP header field to the specified key, value.

  1. func (c *Ctx) Set(key string, val string)
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   c.Set("Content-Type", "text/plain")
  3.   // => "Content-type: text/plain"
  5.   // ...
  6. })

SetUserContext

Sets the user specified implementation for context interface.

  1. func (c *Ctx) SetUserContext(ctx context.Context)
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   ctx := context.Background()
  3.   c.SetUserContext(ctx)
  4.   // Here ctx could be any context implementation
  6.   // ...
  7. })

Stale

https://expressjs.com/en/4x/api.html#req.stale

  1. func (c *Ctx) Stale() bool

Status

Sets the HTTP status for the response.

Method is a chainable. 

  1. func (c *Ctx) Status(status int) *Ctx
  1. app.Get("/fiber", func(c *fiber.Ctx) error {
  2.   c.Status(200)
  3.   return nil
  4. }
  6. app.Get("/hello", func(c *fiber.Ctx) error {
  7.   return c.Status(400).SendString("Bad Request")
  8. }
  10. app.Get("/world", func(c *fiber.Ctx) error {
  11.   return c.Status(404).SendFile("./public/gopher.png")
  12. })

Subdomains

Returns a string slice of subdomains in the domain name of the request.

The application property subdomain offset, which defaults to 2, is used for determining the beginning of the subdomain segments.

  1. func (c *Ctx) Subdomains(offset ...int) []string
  1. // Host: "tobi.ferrets.example.com"
  3. app.Get("/", func(c *fiber.Ctx) error {
  4.   c.Subdomains()  // ["ferrets", "tobi"]
  5.   c.Subdomains(1) // ["tobi"]
  7.   // ...
  8. })

Type

Sets the Content-Type HTTP header to the MIME type listed here specified by the file extension.

  1. func (c *Ctx) Type(ext string, charset ...string) *Ctx
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   c.Type(".html") // => "text/html"
  3.   c.Type("html")  // => "text/html"
  4.   c.Type("png")   // => "image/png"
  6.   c.Type("json", "utf-8")  // => "application/json; charset=utf-8"
  8.   // ...
  9. })

UserContext

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

  1. func (c *Ctx) UserContext() context.Context
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   ctx := c.UserContext()
  3.   // ctx is context implementation set by user
  5.   // ...
  6. })

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.

Multiple fields are allowed. 

  1. func (c *Ctx) Vary(fields ...string)
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   c.Vary("Origin")     // => Vary: Origin
  3.   c.Vary("User-Agent") // => Vary: Origin, User-Agent
  5.   // No duplicates
  6.   c.Vary("Origin") // => Vary: Origin, User-Agent
  8.   c.Vary("Accept-Encoding", "Accept")
  9.   // => Vary: Origin, User-Agent, Accept-Encoding, Accept
  11.   // ...
  12. })

Write

Write adopts the Writer interface

  1. func (c *Ctx) Write(p []byte) (n int, err error)
  1. app.Get("/", func(c *fiber.Ctx) error {
  2.   c.Write([]byte("Hello, World!")) // => "Hello, World!"
  4.   fmt.Fprintf(c, "%s\n", "Hello, World!") // "Hello, World!Hello, World!"
  5. })

XHR

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).

  1. func (c *Ctx) XHR() bool
  1. // X-Requested-With: XMLHttpRequest
  3. app.Get("/", func(c *fiber.Ctx) error {
  4.   c.XHR() // true
  6.   // ...
  7. })