https://github.com/gorilla/reverse
Package gorilla/reverse is a set of utilities to create request routers.
https://github.com/gorilla/reverse
go golang gorilla gorilla-web-toolkit http router
Last synced: 3 months ago
JSON representation
Package gorilla/reverse is a set of utilities to create request routers.
- Host: GitHub
- URL: https://github.com/gorilla/reverse
- Owner: gorilla
- License: bsd-3-clause
- Created: 2012-10-02T21:36:46.000Z (over 13 years ago)
- Default Branch: main
- Last Pushed: 2023-11-05T22:00:30.000Z (about 2 years ago)
- Last Synced: 2025-06-04T16:24:07.512Z (8 months ago)
- Topics: go, golang, gorilla, gorilla-web-toolkit, http, router
- Language: Go
- Homepage: https://gorilla.github.io
- Size: 21.5 KB
- Stars: 56
- Watchers: 11
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# reverse
[](https://codecov.io/github/gorilla/reverse)
[](https://godoc.org/github.com/gorilla/reverse)
[](https://sourcegraph.com/github.com/gorilla/reverse?badge)
Package gorilla/reverse is a set of utilities to create request routers.
It provides interfaces to match and extract variables from an HTTP request
and build URLs for registered routes. It also has a variety of matcher
implementations for all kinds of request attributes, among other utilities.
For example, the Regexp type produces reversible regular expressions that
can be used to generate URLs for a regexp-based mux. To demonstrate, let's
compile a simple regexp:
```go
regexp, err := reverse.CompileRegexp(`/foo/1(\d+)3`)
```
Now we can call regexp.Revert() passing variables to fill the capturing groups.
Because our variable is not named, we use an empty string as key for
url.Values, like this:
```go
// url is "/foo/123".
url, err := regexp.Revert(url.Values{"": {"2"}})
```
Non-capturing groups are ignored, but named capturing groups can be filled
normally. Just set the key in url.Values:
```go
regexp, err := reverse.CompileRegexp(`/foo/1(?P\d+)3`)
if err != nil {
panic(err)
}
// url is "/foo/123".
url, err := re.Revert(url.Values{"two": {"2"}})
```
There are a few limitations that can't be changed:
1. Nested capturing groups are ignored; only the outermost groups become
a placeholder. So in `1(\d+([a-z]+))3` there is only one placeholder
although there are two capturing groups: re.Revert(url.Values{"": {"2", "a"}})
results in "123" and not "12a3".
2. Literals inside capturing groups are ignored; the whole group becomes
a placeholder.