README
¶
urlpath
urlpath provides a way to parse URL path elements using a schema
For users of gorilla/mux.
Getting Started
The urlpath package can be added to a project by running:
go get cattlecloud.net/go/urlpath@latest
import "cattlecloud.net/go/urlpath"
Examples
Make use of gorilla's path variables.
router.Handle("/v1/{category}/{name}, newHandler())
Create a Schema and call Parse to extract the path variables.
var (
category int
name string
)
err := urlpath.Parse(request, urlpath.Schema {
"category": urlpath.Int(&category),
"name": urlpath.String(&name),
})
License
The cattlecloud.net/go/urlpath module is open source under the BSD license.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type IntType ¶
type IntType interface {
~int | ~int8 | ~int16 | ~int32 | ~int64 |
~uint | ~uint8 | ~uint16 | ~uint32 | ~uint64
}
IntType represents any type compatible with the Go integer built-in types, to be used as a destination for writing the value of an url path element.
type Parameter ¶
type Parameter string
A Parameter is a named element of a URL route, encoded such that a gorilla router interprets it as a path parameter.
type Parser ¶
A Parser parses raw input into a destination variable.
func String ¶
func String[T StringType](s *T) Parser
String creates a parser that will parse a path element into s.
type Schema ¶
A Schema describes how path variables should be parsed. Currently only int and string types are supported.
type StringType ¶
type StringType interface {
~string
}
Source Files