server

Documentation

Index

• func CreateMux(routes []router.Router) *mux.Router
• type Route
  • func NewDeleteRoute(path string, handler httputils.APIFunc) Route
  • func NewGetRoute(path string, handler httputils.APIFunc) Route
  • func NewHeadRoute(path string, handler httputils.APIFunc) Route
  • func NewOptionsRoute(path string, handler httputils.APIFunc) Route
  • func NewPostRoute(path string, handler httputils.APIFunc) Route
  • func NewPutRoute(path string, handler httputils.APIFunc) Route
  • func NewRoute(method, path string, handler httputils.APIFunc) Route

Functions

func CreateMux

func CreateMux(routes []router.Router) *mux.Router

https://github.com/moby/moby/blob/fdf7f4d4ea38e0af3967668c5e2fd06046b8bead/api/server/server.go#L166

Types

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 NewDeleteRoute

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

NewDeleteRoute initializes a new route with the http method DELETE.

func NewGetRoute

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

NewGetRoute initializes a new route with the http method GET.

func NewHeadRoute

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

NewHeadRoute initializes a new route with the http method HEAD.

func NewOptionsRoute

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

NewOptionsRoute initializes a new route with the http method OPTIONS.

func NewPostRoute

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

NewPostRoute initializes a new route with the http method POST.

func NewPutRoute

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

NewPutRoute initializes a new route with the http method PUT.

func NewRoute

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

NewRoute initializes a new local route for the router.