router

Documentation

Index

• type Route
  • func NewDeleteRoute(path string, handler httputils.APIFunc, opts ...RouteWrapper) Route
  • func NewGetRoute(path string, handler httputils.APIFunc, opts ...RouteWrapper) Route
  • func NewHeadRoute(path string, handler httputils.APIFunc, opts ...RouteWrapper) Route
  • func NewOptionsRoute(path string, handler httputils.APIFunc, opts ...RouteWrapper) Route
  • func NewPostRoute(path string, handler httputils.APIFunc, opts ...RouteWrapper) Route
  • func NewPutRoute(path string, handler httputils.APIFunc, opts ...RouteWrapper) Route
  • func NewRoute(method, path string, handler httputils.APIFunc, opts ...RouteWrapper) Route
• type RouteWrapper
• type Router

Types

type Route

type Route interface {
	// Handler returns the raw function to create the http handler.
	Handler() httputils.APIFunc
	// Method returns the http method the the route responds to.
	Method() string
	// Path returns the subpath where the route responds to.
	Path() string
}

Route defines an individual API route in the server

func NewDeleteRoute

func NewDeleteRoute(path string, handler httputils.APIFunc, opts ...RouteWrapper) Route

NewDeleteRoute initializes a new route with the http method Delete.

func NewGetRoute

func NewGetRoute(path string, handler httputils.APIFunc, opts ...RouteWrapper) Route

NewGetRoute initializes a new route with the http method GET.

func NewHeadRoute

func NewHeadRoute(path string, handler httputils.APIFunc, opts ...RouteWrapper) Route

NewHeadRoute initializes a new route with the http method HEAD.

func NewOptionsRoute

func NewOptionsRoute(path string, handler httputils.APIFunc, opts ...RouteWrapper) Route

NewOptionsRoute initializes a new route with the http method Options.

func NewPostRoute

func NewPostRoute(path string, handler httputils.APIFunc, opts ...RouteWrapper) Route

NewPostRoute initializes a new route with the http method POST.

func NewPutRoute

func NewPutRoute(path string, handler httputils.APIFunc, opts ...RouteWrapper) Route

NewPutRoute initializes a new route with the http method PUT.

func NewRoute

func NewRoute(method, path string, handler httputils.APIFunc, opts ...RouteWrapper) Route

NewRoute initializes a new local route for the routers.

type RouteWrapper

type RouteWrapper func(r Route) Route

type Router

type Router interface {
	// Routes returns the list of routes to add to the server
	Routers() []Route
}

Router defines an interfaces to specify a group of routes to add to the server