route

Documentation

Index

• func AddMiddleware(router *mux.Router, middleware model.MiddlewareFunc)
• func CreateRouter() *mux.Router
• func GetRouteInfo(httpRequest *http.Request) (string, model.ActionFunc, error)
• func HandleFunc(router *mux.Router, endpoint string, method string, path string, ...) *mux.Route
• func HostStatic(router *mux.Router, name string, path string, handler http.Handler) *mux.Route
• func WalkRegisteredRoutes(router *mux.Router) error

Functions

func AddMiddleware

func AddMiddleware(
	router *mux.Router,
	middleware model.MiddlewareFunc,
)

AddMiddleware wraps the mux middleware addition function

func CreateRouter

func CreateRouter() *mux.Router

CreateRouter initializes a router for route registrations

func GetRouteInfo

func GetRouteInfo(httpRequest *http.Request) (string, model.ActionFunc, error)

GetRouteInfo retrieves the registered name and action for the given route

func HandleFunc

func HandleFunc(
	router *mux.Router,
	endpoint string,
	method string,
	path string,
	queries []string,
	handleFunc func(http.ResponseWriter, *http.Request),
	actionFunc model.ActionFunc,
) *mux.Route

HandleFunc wraps the mux route handler

func HostStatic

func HostStatic(
	router *mux.Router,
	name string,
	path string,
	handler http.Handler,
) *mux.Route

HostStatic wraps the mux static content handler

func WalkRegisteredRoutes

func WalkRegisteredRoutes(router *mux.Router) error

WalkRegisteredRoutes examines the registered router for errors