Path Model

doors decodes the page request URI to a struct (path model), as if the address were a serialization format.

Functionality

• Declare multiple path variants (patterns)
• Capture int, string, and float64 params
• Query params

Basic Declaration

You declare a path variant by tagging a struct’s exported boolean-typed field.

type Path struct {
	Path bool `path:"/"`  // match only root path
}

Capture Parts

To capture path parts as struct fields use :FieldName syntax inside path pattern

type Path struct {
	Path bool `path:"/:Id"` // match /123 (and /123/) where 123 is any int 
	Id 	 int // param saved here, field must be exported
}

Path Variants

To provide path variants… provide path variants. In a deserialized struct, only the matched marker will have a true value.

type Path struct {
	Catalog bool `path:"/catalog"` 
	Card    bool `path:"/catalog/:Id"` 
	Id 	    int 
}

Capture To End

You can also match and capture any path “to end” using + after the last (must be last) part capture.

type Path struct {
	Path bool `path:"/info/:Rest+"` // match /info/* where * any not empty path  
	Rest string // must be string or []string for "to end" capture
}

LIMITATIONS

For ease of use, the path pattern is matched to an already URL-decoded string. That means you can’t match or use “/”, “:”, and “+” characters inside path part values, as they will always be treated as pattern syntax.

Query Params

To capture query param, tag target struct field with query. Query params do not affect routing, unless decoding error occured.

type Path struct {
	Path          bool `path:"/catalog"` 
	ColorFilter   *string `query:"color"` // ?color=red 
}

Decoding and encoding are provided by the go-playground/form v4 library. So refer to its documentation for all features.

Use pointer type to omit default values from URL query string.

Capture Any path

A code snippet that catches any path; you can use it to serve a 404 page.

type AnyPath struct {
  IsRoot bool `path:"/"` 
  IsPath bool `path:"/:Path+"` // capture to end
	Path   string // or []string to get individual parts 	
}

Link Behavior

Navigation within the same path model type triggers a dynamic page update, whereas a link to a different type leads to a full-page load.