router

Documentation

Index

• type Route
  • func NewGetRoute(path string, handler api.Function) Route
  • func NewPostRoute(path string, handler api.Function) Route
  • func NewRoute(method string, path string, handler api.Function) Route
• type Router

Types

type Route

type Route interface {
	// Handler returns the raw function to create the http handler.
	Handler() api.Function
	// Method returns the http method that 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 NewGetRoute

func NewGetRoute(path string, handler api.Function) Route

func NewPostRoute

func NewPostRoute(path string, handler api.Function) Route

func NewRoute

func NewRoute(method string, path string, handler api.Function) Route

type Router

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

	Close()
}

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