router

Documentation

Index

• func RegisterMethod(method string)
• func StripSegments(prefix string, pat string, h http.Handler) http.Handler
• type ChainHandler
  • func (c *ChainHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Middlewares
  • func Chain(middlewares ...func(http.Handler) http.Handler) Middlewares
  • func (mws Middlewares) Handler(h http.Handler) http.Handler
  • func (mws Middlewares) HandlerFunc(h http.HandlerFunc) http.Handler
• type Mux
  • func NewMux() *Mux
  • func NewRouter() *Mux
  • func (mx *Mux) Connect(pattern string, handlerFn http.HandlerFunc)
  • func (mx *Mux) Delete(pattern string, handlerFn http.HandlerFunc)
  • func (mx *Mux) Get(pattern string, handlerFn http.HandlerFunc)
  • func (mx *Mux) Group(fn func(r Router)) Router
  • func (mx *Mux) Handle(pattern string, handler http.Handler)
  • func (mx *Mux) HandleFunc(pattern string, handlerFn http.HandlerFunc)
  • func (mx *Mux) Head(pattern string, handlerFn http.HandlerFunc)
  • func (mx *Mux) ListRoutes()
  • func (mx *Mux) Method(method, pattern string, handler http.Handler)
  • func (mx *Mux) MethodFunc(method, pattern string, handlerFn http.HandlerFunc)
  • func (mx *Mux) Middlewares() Middlewares
  • func (mx *Mux) Mount(pattern string, handler http.Handler)
  • func (mx *Mux) NotFound(handler http.HandlerFunc)
  • func (mx *Mux) Options(pattern string, handlerFn http.HandlerFunc)
  • func (mx *Mux) Patch(pattern string, handlerFn http.HandlerFunc)
  • func (mx *Mux) Post(pattern string, handlerFn http.HandlerFunc)
  • func (mx *Mux) Prefix(prefix string) *Mux
  • func (mx *Mux) Put(pattern string, handlerFn http.HandlerFunc)
  • func (mx *Mux) Route(pattern string, fn func(r Router)) Router
  • func (mx *Mux) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (mx *Mux) Trace(pattern string, handlerFn http.HandlerFunc)
  • func (mx *Mux) Use(middlewares ...func(http.Handler) http.Handler)
  • func (mx *Mux) With(middlewares ...func(http.Handler) http.Handler) Router
• type Router

Functions

func RegisterMethod

func RegisterMethod(method string)

RegisterMethod adds support for custom HTTP method handlers, available via Router#Method and Router#MethodFunc

func StripSegments

func StripSegments(prefix string, pat string, h http.Handler) http.Handler

StripSegments works like http.StripPrefix, but skips entire segments (including wildcards) and provides path values ​​to subrouters.

Types

type ChainHandler

type ChainHandler struct {
	Endpoint http.Handler

	Middlewares Middlewares
	// contains filtered or unexported fields
}

ChainHandler is a http.Handler with support for handler composition and execution.

func (*ChainHandler) ServeHTTP

func (c *ChainHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Middlewares

type Middlewares []func(http.Handler) http.Handler

Middlewares type is a slice of standard middleware handlers with methods to compose middleware chains and http.Handler's.

func Chain

func Chain(middlewares ...func(http.Handler) http.Handler) Middlewares

Chain returns a Middlewares type from a slice of middleware handlers.

func (Middlewares) Handler

func (mws Middlewares) Handler(h http.Handler) http.Handler

Handler builds and returns a http.Handler from the chain of middlewares, with `h http.Handler` as the final handler.

func (Middlewares) HandlerFunc

func (mws Middlewares) HandlerFunc(h http.HandlerFunc) http.Handler

HandlerFunc builds and returns a http.Handler from the chain of middlewares, with `h http.Handler` as the final handler.

type Mux

type Mux struct {
	// contains filtered or unexported fields
}

func NewMux

func NewMux() *Mux

func NewRouter

func NewRouter() *Mux

NewRouter returns a new Mux object that implements the Router interface.

func (*Mux) Connect

func (mx *Mux) Connect(pattern string, handlerFn http.HandlerFunc)

Connect adds the route `pattern` that matches a CONNECT http method to execute the `handlerFn` http.HandlerFunc.

func (*Mux) Delete

func (mx *Mux) Delete(pattern string, handlerFn http.HandlerFunc)

Delete adds the route `pattern` that matches a DELETE http method to execute the `handlerFn` http.HandlerFunc.

func (*Mux) Get

func (mx *Mux) Get(pattern string, handlerFn http.HandlerFunc)

Get adds the route `pattern` that matches a GET http method to execute the `handlerFn` http.HandlerFunc.

func (*Mux) Group

func (mx *Mux) Group(fn func(r Router)) Router

Group creates a new inline-Mux with a copy of middleware stack. It's useful for a group of handlers along the same routing path that use an additional set of middlewares. See _examples/.

func (*Mux) Handle

func (mx *Mux) Handle(pattern string, handler http.Handler)

Handle adds the route `pattern` that matches any http method to execute the `handler` http.Handler.

func (*Mux) HandleFunc

func (mx *Mux) HandleFunc(pattern string, handlerFn http.HandlerFunc)

HandleFunc adds the route `pattern` that matches any http method to execute the `handlerFn` http.HandlerFunc.

func (*Mux) Head

func (mx *Mux) Head(pattern string, handlerFn http.HandlerFunc)

Head adds the route `pattern` that matches a HEAD http method to execute the `handlerFn` http.HandlerFunc.

func (*Mux) ListRoutes

func (mx *Mux) ListRoutes()

func (*Mux) Method

func (mx *Mux) Method(method, pattern string, handler http.Handler)

Method adds the route `pattern` that matches `method` http method to execute the `handler` http.Handler.

func (*Mux) MethodFunc

func (mx *Mux) MethodFunc(method, pattern string, handlerFn http.HandlerFunc)

MethodFunc adds the route `pattern` that matches `method` http method to execute the `handlerFn` http.HandlerFunc.

func (*Mux) Middlewares

func (mx *Mux) Middlewares() Middlewares

Middlewares returns a slice of middleware handler functions.

func (*Mux) Mount

func (mx *Mux) Mount(pattern string, handler http.Handler)

Mount attaches another http.Handler as a subrouter along a routing path. It's very useful to split up a large API as many independent routers and compose them as a single service using Mount.

Note that Mount() simply sets a wildcard along the `pattern` that will continue routing at the `handler`, which in most cases is another stdchi.Router. As a result, if you define two Mount() routes on the exact same pattern the mount will panic.

func (*Mux) NotFound

func (mx *Mux) NotFound(handler http.HandlerFunc)

func (*Mux) Options

func (mx *Mux) Options(pattern string, handlerFn http.HandlerFunc)

Options adds the route `pattern` that matches an OPTIONS http method to execute the `handlerFn` http.HandlerFunc.

func (*Mux) Patch

func (mx *Mux) Patch(pattern string, handlerFn http.HandlerFunc)

Patch adds the route `pattern` that matches a PATCH http method to execute the `handlerFn` http.HandlerFunc.

func (*Mux) Post

func (mx *Mux) Post(pattern string, handlerFn http.HandlerFunc)

Post adds the route `pattern` that matches a POST http method to execute the `handlerFn` http.HandlerFunc.

func (*Mux) Prefix

func (mx *Mux) Prefix(prefix string) *Mux

func (*Mux) Put

func (mx *Mux) Put(pattern string, handlerFn http.HandlerFunc)

Put adds the route `pattern` that matches a PUT http method to execute the `handlerFn` http.HandlerFunc.

func (*Mux) Route

func (mx *Mux) Route(pattern string, fn func(r Router)) Router

Route creates a new Mux and mounts it along the `pattern` as a subrouter. Effectively, this is a short-hand call to Mount. See _examples/.

func (*Mux) ServeHTTP

func (mx *Mux) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*Mux) Trace

func (mx *Mux) Trace(pattern string, handlerFn http.HandlerFunc)

Trace adds the route `pattern` that matches a TRACE http method to execute the `handlerFn` http.HandlerFunc.

func (*Mux) Use

func (mx *Mux) Use(middlewares ...func(http.Handler) http.Handler)

Use appends a middleware handler to the Mux middleware stack.

The middleware stack for any Mux will execute before searching for a matching route to a specific handler, which provides opportunity to respond early, change the course of the request execution, or set request-scoped values for the next http.Handler.

func (*Mux) With

func (mx *Mux) With(middlewares ...func(http.Handler) http.Handler) Router

With adds inline middlewares for an endpoint handler.

type Router

type Router interface {
	http.Handler

	// Middlewares returns the list of middlewares in use by the router.
	Middlewares() Middlewares

	// Use appends one or more middlewares onto the Router stack.
	Use(middlewares ...func(http.Handler) http.Handler)

	// With adds inline middlewares for an endpoint handler.
	With(middlewares ...func(http.Handler) http.Handler) Router

	// Group adds a new inline-Router along the current routing
	// path, with a fresh middleware stack for the inline-Router.
	Group(fn func(r Router)) Router

	// Route mounts a sub-Router along a `pattern“ string.
	Route(pattern string, fn func(r Router)) Router

	// Mount attaches another http.Handler along ./pattern/*
	Mount(pattern string, h http.Handler)

	// Handle and HandleFunc adds routes for `pattern` that matches
	// all HTTP methods.
	Handle(pattern string, h http.Handler)
	HandleFunc(pattern string, h http.HandlerFunc)

	// Method and MethodFunc adds routes for `pattern` that matches
	// the `method` HTTP method.
	Method(method, pattern string, h http.Handler)
	MethodFunc(method, pattern string, h http.HandlerFunc)

	// HTTP-method routing along `pattern`
	Connect(pattern string, h http.HandlerFunc)
	Delete(pattern string, h http.HandlerFunc)
	Get(pattern string, h http.HandlerFunc)
	Head(pattern string, h http.HandlerFunc)
	Options(pattern string, h http.HandlerFunc)
	Patch(pattern string, h http.HandlerFunc)
	Post(pattern string, h http.HandlerFunc)
	Put(pattern string, h http.HandlerFunc)
	Trace(pattern string, h http.HandlerFunc)

	NotFound(h http.HandlerFunc)
	ListRoutes()
}

Router consisting of the core routing methods, following go/chi