 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Index ¶
- type ExperimentalRoute
- type Route
- func Experimental(r Route) 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
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ExperimentalRoute ¶
type ExperimentalRoute interface {
	Route
	Enable()
	Disable()
}
    ExperimentalRoute defines an experimental API route that can be enabled or disabled.
type Route ¶
type Route interface {
	// Handler returns the raw function to create the http handler.
	Handler() httputils.APIFunc
	// 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 docker server.
func Experimental ¶
Experimental will mark a route as experimental.
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.
type RouteWrapper ¶
RouteWrapper wraps a route with extra functionality. It is passed in when creating a new route.