Help us shape the future of Go! Take the 2026 Go Developer Survey

operations

package
v0.1.1 Latest Latest
Warning

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

Go to latest
Published: Dec 20, 2017 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIManagerAPI

type APIManagerAPI struct {
	Middleware func(middleware.Builder) http.Handler

	// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
	// It has a default implemention in the security package, however you can replace it for your particular usage.
	BasicAuthenticator func(security.UserPassAuthentication) runtime.Authenticator
	// APIKeyAuthenticator generates a runtime.Authenticator from the supplied token auth function.
	// It has a default implemention in the security package, however you can replace it for your particular usage.
	APIKeyAuthenticator func(string, string, security.TokenAuthentication) runtime.Authenticator
	// BearerAuthenticator generates a runtime.Authenticator from the supplied bearer token auth function.
	// It has a default implemention in the security package, however you can replace it for your particular usage.
	BearerAuthenticator func(string, security.ScopedTokenAuthentication) runtime.Authenticator

	// JSONConsumer registers a consumer for a "application/json" mime type
	JSONConsumer runtime.Consumer

	// JSONProducer registers a producer for a "application/json" mime type
	JSONProducer runtime.Producer

	// CookieAuth registers a function that takes a token and returns a principal
	// it performs authentication based on an api key Cookie provided in the header
	CookieAuth func(string) (interface{}, error)

	// APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal
	APIAuthorizer runtime.Authorizer

	// EndpointAddAPIHandler sets the operation handler for the add API operation
	EndpointAddAPIHandler endpoint.AddAPIHandler
	// EndpointDeleteAPIHandler sets the operation handler for the delete API operation
	EndpointDeleteAPIHandler endpoint.DeleteAPIHandler
	// EndpointGetAPIHandler sets the operation handler for the get API operation
	EndpointGetAPIHandler endpoint.GetAPIHandler
	// EndpointGetApisHandler sets the operation handler for the get apis operation
	EndpointGetApisHandler endpoint.GetApisHandler
	// EndpointUpdateAPIHandler sets the operation handler for the update API operation
	EndpointUpdateAPIHandler endpoint.UpdateAPIHandler

	// ServeError is called when an error is received, there is a default handler
	// but you can set your own with this
	ServeError func(http.ResponseWriter, *http.Request, error)

	// ServerShutdown is called when the HTTP(S) server is shut down and done
	// handling all active connections and does not accept connections any more
	ServerShutdown func()

	// Custom command line argument groups with their descriptions
	CommandLineOptionsGroups []swag.CommandLineOptionsGroup

	// User defined logger function.
	Logger func(string, ...interface{})
	// contains filtered or unexported fields
}

APIManagerAPI VMware Dispatch - API Manager APIs

func NewAPIManagerAPI

func NewAPIManagerAPI(spec *loads.Document) *APIManagerAPI

NewAPIManagerAPI creates a new APIManager instance

func (*APIManagerAPI) AuthenticatorsFor

func (o *APIManagerAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*APIManagerAPI) Authorizer

func (o *APIManagerAPI) Authorizer() runtime.Authorizer

Authorizer returns the registered authorizer

func (*APIManagerAPI) ConsumersFor

func (o *APIManagerAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer

ConsumersFor gets the consumers for the specified media types

func (*APIManagerAPI) Context

func (o *APIManagerAPI) Context() *middleware.Context

Context returns the middleware context for the API manager API

func (*APIManagerAPI) DefaultConsumes

func (o *APIManagerAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*APIManagerAPI) DefaultProduces

func (o *APIManagerAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*APIManagerAPI) Formats

func (o *APIManagerAPI) Formats() strfmt.Registry

Formats returns the registered string formats

func (*APIManagerAPI) HandlerFor

func (o *APIManagerAPI) HandlerFor(method, path string) (http.Handler, bool)

HandlerFor gets a http.Handler for the provided operation method and path

func (*APIManagerAPI) Init

func (o *APIManagerAPI) Init()

Init allows you to just initialize the handler cache, you can then recompose the middelware as you see fit

func (*APIManagerAPI) ProducersFor

func (o *APIManagerAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer

ProducersFor gets the producers for the specified media types

func (*APIManagerAPI) RegisterFormat

func (o *APIManagerAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)

RegisterFormat registers a custom format validator

func (*APIManagerAPI) Serve

func (o *APIManagerAPI) Serve(builder middleware.Builder) http.Handler

Serve creates a http handler to serve the API over HTTP can be used directly in http.ListenAndServe(":8000", api.Serve(nil))

func (*APIManagerAPI) ServeErrorFor

func (o *APIManagerAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)

ServeErrorFor gets a error handler for a given operation id

func (*APIManagerAPI) SetDefaultConsumes

func (o *APIManagerAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*APIManagerAPI) SetDefaultProduces

func (o *APIManagerAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*APIManagerAPI) SetSpec

func (o *APIManagerAPI) SetSpec(spec *loads.Document)

SetSpec sets a spec that will be served for the clients.

func (*APIManagerAPI) Validate

func (o *APIManagerAPI) Validate() error

Validate validates the registrations in the APIManagerAPI

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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