rewrite

package
v3.7.0 Latest Latest
Warning

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

Go to latest
Published: Nov 9, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

func New(config ...Config) fiber.Handler

New creates a new middleware handler

Types

type Config

type Config struct {
	// Next defines a function to skip middleware.
	// Optional. Default: nil
	Next func(fiber.Ctx) bool

	// Rules defines the URL path rewrite rules. The values captured in asterisk can be
	// retrieved by index e.g. $1, $2 and so on.
	//
	// Deprecated: Use RuleList instead. A map has no order, so the rule
	// answering a path two rules both match is decided by a documented heuristic
	// rather than by the author. Retained for backward compatibility with
	// existing configurations.
	Rules map[string]string

	// RuleList defines the URL path rewrite rules. They are tried in the order
	// given and the first rule whose From matches the request path wins, as
	// routes do; nothing reorders the list. Put the specific rules before the
	// catch-alls. Set this or the deprecated Rules, not both.
	//
	// Example:
	// {From: "/old", To: "/new"},
	// {From: "/api/*", To: "/$1"},
	// {From: "/js/*", To: "/public/javascript/$1"},
	// {From: "/users/*/orders/*", To: "/user/$1/order/$2"},
	RuleList []Rule
}

Config defines the config for middleware.

type Rule added in v3.6.0

type Rule struct {
	// From is the path pattern, where "*" matches a run of any bytes but a
	// newline and every other byte stands for itself. There is no escape for a
	// literal "*".
	From string

	// To is the new path, where "$1", "$2" and so on stand for what the
	// asterisks of From captured.
	To string
}

Rule is one rewrite: the path pattern to match and the path to rewrite it to. The values captured in asterisk can be retrieved by index e.g. $1, $2 and so on.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL