operations

package
v0.0.0-...-8e43be5 Latest Latest
Warning

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

Go to latest
Published: Mar 27, 2020 License: GPL-3.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type StockSmithMicroservicesAPI

type StockSmithMicroservicesAPI 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

	// StockAPIGetStocksQueryStockHandler sets the operation handler for the get stocks query stock operation
	StockAPIGetStocksQueryStockHandler stock_api.GetStocksQueryStockHandler
	// StockAPIGetStocksQueryTopHandler sets the operation handler for the get stocks query top operation
	StockAPIGetStocksQueryTopHandler stock_api.GetStocksQueryTopHandler
	// NewsAPIPostNewsQueryHandler sets the operation handler for the post news query operation
	NewsAPIPostNewsQueryHandler news_api.PostNewsQueryHandler
	// 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
}

StockSmithMicroservicesAPI the stock smith microservices API

func NewStockSmithMicroservicesAPI

func NewStockSmithMicroservicesAPI(spec *loads.Document) *StockSmithMicroservicesAPI

NewStockSmithMicroservicesAPI creates a new StockSmithMicroservices instance

func (*StockSmithMicroservicesAPI) AuthenticatorsFor

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*StockSmithMicroservicesAPI) Authorizer

Authorizer returns the registered authorizer

func (*StockSmithMicroservicesAPI) ConsumersFor

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

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

func (*StockSmithMicroservicesAPI) Context

Context returns the middleware context for the stock smith microservices API

func (*StockSmithMicroservicesAPI) DefaultConsumes

func (o *StockSmithMicroservicesAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*StockSmithMicroservicesAPI) DefaultProduces

func (o *StockSmithMicroservicesAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*StockSmithMicroservicesAPI) Formats

Formats returns the registered string formats

func (*StockSmithMicroservicesAPI) HandlerFor

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

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

func (*StockSmithMicroservicesAPI) Init

func (o *StockSmithMicroservicesAPI) Init()

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

func (*StockSmithMicroservicesAPI) ProducersFor

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

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

func (*StockSmithMicroservicesAPI) RegisterConsumer

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

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

func (*StockSmithMicroservicesAPI) RegisterFormat

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

RegisterFormat registers a custom format validator

func (*StockSmithMicroservicesAPI) RegisterProducer

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

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

func (*StockSmithMicroservicesAPI) Serve

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

func (*StockSmithMicroservicesAPI) ServeErrorFor

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

ServeErrorFor gets a error handler for a given operation id

func (*StockSmithMicroservicesAPI) SetDefaultConsumes

func (o *StockSmithMicroservicesAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*StockSmithMicroservicesAPI) SetDefaultProduces

func (o *StockSmithMicroservicesAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*StockSmithMicroservicesAPI) SetSpec

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

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

func (*StockSmithMicroservicesAPI) Validate

func (o *StockSmithMicroservicesAPI) Validate() error

Validate validates the registrations in the StockSmithMicroservicesAPI

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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