router

package
v27.2.1+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 6, 2024 License: Apache-2.0 Imports: 3 Imported by: 2,107

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ExperimentalRoute added in v1.13.0

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 added in v1.13.0

func Experimental(r Route) Route

Experimental will mark a route as experimental.

func NewDeleteRoute added in v1.11.0

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

NewDeleteRoute initializes a new route with the http method DELETE.

func NewGetRoute added in v1.11.0

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

NewGetRoute initializes a new route with the http method GET.

func NewHeadRoute added in v1.11.0

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

NewHeadRoute initializes a new route with the http method HEAD.

func NewOptionsRoute added in v1.11.0

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

NewOptionsRoute initializes a new route with the http method OPTIONS.

func NewPostRoute added in v1.11.0

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

NewPostRoute initializes a new route with the http method POST.

func NewPutRoute added in v1.11.0

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

NewPutRoute initializes a new route with the http method PUT.

func NewRoute added in v1.11.0

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

NewRoute initializes a new local route for the router.

type RouteWrapper

type RouteWrapper func(r Route) Route

RouteWrapper wraps a route with extra functionality. It is passed in when creating a new route.

type Router

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

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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL