Skip to main content
Version: Next

🔄 Redirect

Redirect helpers send the client to another URL or route.

Redirect Methods​

To​

Redirects to a URL built from the given path. Optionally set an HTTP status.

info

If unspecified, status defaults to 303 See Other.

Signature
func (r *Redirect) To(location string) error
Example
app.Get("/coffee", func(c fiber.Ctx) error {
  // => HTTP - GET 301 /teapot
  return c.Redirect().Status(fiber.StatusMovedPermanently).To("/teapot")
})

app.Get("/teapot", func(c fiber.Ctx) error {
  return c.Status(fiber.StatusTeapot).Send("🍵 short and stout 🍵")
})
More examples
app.Get("/", func(c fiber.Ctx) error {
  // => HTTP - GET 303 /foo/bar
  return c.Redirect().To("/foo/bar")
  // => HTTP - GET 303 ../login
  return c.Redirect().To("../login")
  // => HTTP - GET 303 http://example.com
  return c.Redirect().To("http://example.com")
  // => HTTP - GET 301 https://example.com
  return c.Redirect().Status(301).To("http://example.com")
})

Route​

Redirects to a named route with parameters and queries.

info

To send params and queries to a route, use the RedirectConfig struct.

Signature
func (r *Redirect) Route(name string, config ...RedirectConfig) error
Example
app.Get("/", func(c fiber.Ctx) error {
  // /user/fiber
  return c.Redirect().Route("user", fiber.RedirectConfig{
    Params: fiber.Map{
      "name": "fiber",
    },
  })
})

app.Get("/with-queries", func(c fiber.Ctx) error {
  // /user/fiber?data[0][name]=john&data[0][age]=10&test=doe
  return c.Redirect().Route("user", fiber.RedirectConfig{
    Params: fiber.Map{
      "name": "fiber",
    },
    Queries: map[string]string{
      "data[0][name]": "john",
      "data[0][age]":  "10",
      "test":          "doe",
    },
  })
})

app.Get("/user/:name", func(c fiber.Ctx) error {
  return c.SendString(c.Params("name"))
}).Name("user")
note

A named route is a route in this application, so the redirect always stays on this origin: a Params value that would open an authority — "/evil.com" or "\evil.com" under a /* route — is kept as the path segment the route asked for. Route.URL and GetRouteURL answer the same for the same input.

Queries are merged into whatever query the composed path already holds and placed ahead of any fragment, so a Params value carrying ? or # cannot absorb or discard them.

The values themselves are still written into the path as given. Where they come from the request, escape them with url.PathEscape if the route expects one segment per parameter.

Back​

Redirects to the referer. If it's missing, fall back to the provided URL. You can also set the status code.

info

If unspecified, status defaults to 303 See Other.

note

The referer is only used when it is same-origin with the current request, and the value sent in Location is a normalized form of it, not the raw header. The check reads the referer the way a browser does — folding backslashes, dropping ASCII tab, CR and LF, and collapsing a leading run of slashes — so a value like /\evil.com, which a browser resolves to //evil.com, is not mistaken for a local path. A referer that is missing, cross-origin, or unparsable falls back to the provided URL, and Back returns an error if there is no fallback.

Signature
func (r *Redirect) Back(fallback string) error
Example
app.Get("/", func(c fiber.Ctx) error {
  return c.SendString("Home page")
})

app.Get("/test", func(c fiber.Ctx) error {
  c.Set("Content-Type", "text/html")
  return c.SendString(`<a href="/back">Back</a>`)
})

app.Get("/back", func(c fiber.Ctx) error {
  return c.Redirect().Back("/")
})

Controls​

info

Methods are chainable.

Status​

Sets the HTTP status code for the redirect.

info

It is used in conjunction with To, Route, and Back methods.

Signature
func (r *Redirect) Status(status int) *Redirect
Example
app.Get("/coffee", func(c fiber.Ctx) error {
  // => HTTP - GET 301 /teapot
  return c.Redirect().Status(fiber.StatusMovedPermanently).To("/teapot")
})

RedirectConfig​

Sets the configuration for the redirect.

info

It is used in conjunction with the Route method.

Definition
// RedirectConfig is a config to use with Redirect().Route()
type RedirectConfig struct {
  Params  fiber.Map         // Route parameters
  Queries map[string]string // Query map
}

Flash Message​

Similar to Laravel, we can flash a message and retrieve it in the next request.

Messages​

Retrieve all flash messages. See With for details.

Signature
func (r *Redirect) Messages() []FlashMessage
Example
app.Get("/", func(c fiber.Ctx) error {
  messages := c.Redirect().Messages()
  return c.JSON(messages)
})

Message​

Get a flash message by key; see With.

Signature
func (r *Redirect) Message(key string) FlashMessage
Example
app.Get("/", func(c fiber.Ctx) error {
  message := c.Redirect().Message("status")
  return c.SendString(message.Value)
})

OldInputs​

Retrieve stored input data. See WithInput.

Signature
func (r *Redirect) OldInputs() []OldInputData
Example
app.Get("/", func(c fiber.Ctx) error {
  oldInputs := c.Redirect().OldInputs()
  return c.JSON(oldInputs)
})

OldInput​

Get stored input data by key; see WithInput.

Signature
func (r *Redirect) OldInput(key string) OldInputData
Example
app.Get("/name", func(c fiber.Ctx) error {
  oldInput := c.Redirect().OldInput("name")
  return c.SendString(oldInput.Value)
})

With​

Send flash messages with With.

Signature
func (r *Redirect) With(key, value string) *Redirect
Example
app.Get("/login", func(c fiber.Ctx) error {
  return c.Redirect().With("status", "Logged in successfully").To("/")
})

app.Get("/", func(c fiber.Ctx) error {
  // => Logged in successfully
  return c.SendString(c.Redirect().Message("status"))
})

WithInput​

Send input data with WithInput, which stores them in a cookie.

It captures form, multipart, or query data depending on the request content type.

caution

WithInput copies the whole submitted body into the fiber_flash cookie — a rejected login carries the password the user just typed. The payload is hex-encoded, not encrypted or signed, so anything sensitive in the request goes back to the browser as a cookie value. Prefer With for the specific fields you need to carry across the redirect.

The cookie is HttpOnly, and Secure when the request that produced it arrived over TLS — so script cannot read it and it is not replayed in the clear. Neither attribute protects the payload from whoever is at the browser.

Signature
func (r *Redirect) WithInput() *Redirect
Example
// curl -X POST http://localhost:3000/login -d "name=John"
app.Post("/login", func(c fiber.Ctx) error {
  return c.Redirect().WithInput().Route("name")
})

app.Get("/name", func(c fiber.Ctx) error {
  // => John
  return c.SendString(c.Redirect().OldInput("name"))
}).Name("name")