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

operations

package
v1.1.0 Latest Latest
Warning

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

Go to latest
Published: Sep 3, 2021 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 APIAPI added in v1.1.0

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

	// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
	// It has a default implementation 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 implementation 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 implementation 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 the following mime types:
	//   - application/json
	JSONConsumer runtime.Consumer

	// JSONProducer registers a producer for the following mime types:
	//   - application/json
	JSONProducer runtime.Producer

	// SimpleJSONAnnotationQueryHandler sets the operation handler for the annotation query operation
	SimpleJSONAnnotationQueryHandler simple_json.AnnotationQueryHandler
	// SimpleJSONMetricFindQueryHandler sets the operation handler for the metric find query operation
	SimpleJSONMetricFindQueryHandler simple_json.MetricFindQueryHandler
	// SimpleJSONQueryHandler sets the operation handler for the query operation
	SimpleJSONQueryHandler simple_json.QueryHandler
	// SimpleJSONTestDatasourceHandler sets the operation handler for the test datasource operation
	SimpleJSONTestDatasourceHandler simple_json.TestDatasourceHandler

	// 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)

	// PreServerShutdown is called before the HTTP(S) server is shutdown
	// This allows for custom functions to get executed before the HTTP(S) server stops accepting traffic
	PreServerShutdown func()

	// 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
}

APIAPI This is a sample mongodb proxy server.

func NewAPIAPI added in v1.1.0

func NewAPIAPI(spec *loads.Document) *APIAPI

NewAPIAPI creates a new API instance

func (*APIAPI) AddMiddlewareFor added in v1.1.0

func (o *APIAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)

AddMiddlewareFor adds a http middleware to existing handler

func (*APIAPI) AuthenticatorsFor added in v1.1.0

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*APIAPI) Authorizer added in v1.1.0

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

Authorizer returns the registered authorizer

func (*APIAPI) ConsumersFor added in v1.1.0

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

ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.

func (*APIAPI) Context added in v1.1.0

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

Context returns the middleware context for the API API

func (*APIAPI) DefaultConsumes added in v1.1.0

func (o *APIAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*APIAPI) DefaultProduces added in v1.1.0

func (o *APIAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*APIAPI) Formats added in v1.1.0

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

Formats returns the registered string formats

func (*APIAPI) HandlerFor added in v1.1.0

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

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

func (*APIAPI) Init added in v1.1.0

func (o *APIAPI) Init()

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

func (*APIAPI) ProducersFor added in v1.1.0

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

ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.

func (*APIAPI) RegisterConsumer added in v1.1.0

func (o *APIAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)

RegisterConsumer allows you to add (or override) a consumer for a media type.

func (*APIAPI) RegisterFormat added in v1.1.0

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

RegisterFormat registers a custom format validator

func (*APIAPI) RegisterProducer added in v1.1.0

func (o *APIAPI) RegisterProducer(mediaType string, producer runtime.Producer)

RegisterProducer allows you to add (or override) a producer for a media type.

func (*APIAPI) Serve added in v1.1.0

func (o *APIAPI) 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 (*APIAPI) ServeErrorFor added in v1.1.0

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

ServeErrorFor gets a error handler for a given operation id

func (*APIAPI) SetDefaultConsumes added in v1.1.0

func (o *APIAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*APIAPI) SetDefaultProduces added in v1.1.0

func (o *APIAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*APIAPI) SetSpec added in v1.1.0

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

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

func (*APIAPI) UseRedoc added in v1.1.0

func (o *APIAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*APIAPI) UseSwaggerUI added in v1.1.0

func (o *APIAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*APIAPI) Validate added in v1.1.0

func (o *APIAPI) Validate() error

Validate validates the registrations in the APIAPI

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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