router

type Handlers ¶

type Handlers map[string]http.Handler

Handlers map Handler keys to http.Handler objects. The Handler key is used to then match the Handler to the appropriate Route in the Router.

type Params ¶

type Params map[string]string

Params map path keys to values. For example, if your route has the path pattern:

/person/:person_id/pets/:pet_type

Then a correct Params map would lool like:

router.Params{
  "person_id": "123",
  "pet_type": "cats",
}

type RequestGenerator ¶

type RequestGenerator struct {
	Header http.Header
	// contains filtered or unexported fields
}

func NewRequestGenerator(host string, routes Routes) *RequestGenerator

func (r *RequestGenerator) RequestForHandler(
	handler string,
	params Params,
	body io.Reader,
) (*http.Request, error)

type Route ¶

type Route struct {
	// Handler is a key specifying which HTTP handler the router
	// should associate with the endpoint at runtime.
	Handler string
	// Method is one of the following: GET,PUT,POST,DELETE
	Method string
	// Path contains a path pattern
	Path string
}

A Route defines properties of an HTTP endpoint. At runtime, the router will associate each Route with a http.Handler object, and use the Route properties to determine which Handler should be invoked.

Currently, properties used in match are such as Method and Path.

Method is one of the following:

GET PUT POST DELETE

Path conforms to Pat-style pattern matching. The following docs are taken from http://godoc.org/github.com/bmizerany/pat#PatternServeMux

Path Patterns may contain literals or captures. Capture names start with a colon and consist of letters A-Z, a-z, _, and 0-9. The rest of the pattern matches literally. The portion of the URL matching each name ends with an occurrence of the character in the pattern immediately following the name, or a /, whichever comes first. It is possible for a name to match the empty string.

Example pattern with one capture:

/hello/:name

Will match:

/hello/blake
/hello/keith

Will not match:

/hello/blake/
/hello/blake/foo
/foo
/foo/bar

Example 2:

/hello/:name/

Will match:

/hello/blake/
/hello/keith/foo
/hello/blake
/hello/keith

Will not match:

/foo
/foo/bar

func (r Route) PathWithParams(params Params) (string, error)

type Routes ¶

type Routes []Route

Routes is a Route collection.

func (r Routes) PathForHandler(handler string, params Params) (string, error)

func (r Routes) RouteForHandler(handler string) (Route, bool)

func (r Routes) Router(handlers Handlers) (http.Handler, error)