operations

Documentation

Index

• type SpoonAPI
  • func NewSpoonAPI(spec *loads.Document) *SpoonAPI
  • func (o *SpoonAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
  • func (o *SpoonAPI) Authorizer() runtime.Authorizer
  • func (o *SpoonAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
  • func (o *SpoonAPI) Context() *middleware.Context
  • func (o *SpoonAPI) DefaultConsumes() string
  • func (o *SpoonAPI) DefaultProduces() string
  • func (o *SpoonAPI) Formats() strfmt.Registry
  • func (o *SpoonAPI) HandlerFor(method, path string) (http.Handler, bool)
  • func (o *SpoonAPI) Init()
  • func (o *SpoonAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
  • func (o *SpoonAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
  • func (o *SpoonAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
  • func (o *SpoonAPI) RegisterProducer(mediaType string, producer runtime.Producer)
  • func (o *SpoonAPI) Serve(builder middleware.Builder) http.Handler
  • func (o *SpoonAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
  • func (o *SpoonAPI) SetDefaultConsumes(mediaType string)
  • func (o *SpoonAPI) SetDefaultProduces(mediaType string)
  • func (o *SpoonAPI) SetSpec(spec *loads.Document)
  • func (o *SpoonAPI) Validate() error

Types

type SpoonAPI

type SpoonAPI 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 a "application/com.github.xbcsmith.spoon.v1+json" mime type
	JSONConsumer runtime.Consumer

	// JSONProducer registers a producer for a "application/com.github.xbcsmith.spoon.v1+json" mime type
	JSONProducer runtime.Producer

	// KeyAuth registers a function that takes a token and returns a principal
	// it performs authentication based on an api key x-spoon-token provided in the header
	KeyAuth func(string) (*models.Principal, error)

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

	// SpoonsAddSpoonHandler sets the operation handler for the add spoon operation
	SpoonsAddSpoonHandler spoons.AddSpoonHandler
	// SpoonsDestroySpoonHandler sets the operation handler for the destroy spoon operation
	SpoonsDestroySpoonHandler spoons.DestroySpoonHandler
	// SpoonsFindSpoonsHandler sets the operation handler for the find spoons operation
	SpoonsFindSpoonsHandler spoons.FindSpoonsHandler
	// HealthzGetLivenessHandler sets the operation handler for the get liveness operation
	HealthzGetLivenessHandler healthz.GetLivenessHandler
	// HealthzGetReadinessHandler sets the operation handler for the get readiness operation
	HealthzGetReadinessHandler healthz.GetReadinessHandler
	// SpoonsGetSpoonHandler sets the operation handler for the get spoon operation
	SpoonsGetSpoonHandler spoons.GetSpoonHandler
	// SpoonsUpdateSpoonHandler sets the operation handler for the update spoon operation
	SpoonsUpdateSpoonHandler spoons.UpdateSpoonHandler

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

SpoonAPI Spoons are Silverware

func NewSpoonAPI

func NewSpoonAPI(spec *loads.Document) *SpoonAPI

NewSpoonAPI creates a new Spoon instance

func (*SpoonAPI) AuthenticatorsFor

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*SpoonAPI) Authorizer

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

Authorizer returns the registered authorizer

func (*SpoonAPI) ConsumersFor

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

ConsumersFor gets the consumers for the specified media types

func (*SpoonAPI) Context

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

Context returns the middleware context for the spoon API

func (*SpoonAPI) DefaultConsumes

func (o *SpoonAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*SpoonAPI) DefaultProduces

func (o *SpoonAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*SpoonAPI) Formats

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

Formats returns the registered string formats

func (*SpoonAPI) HandlerFor

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

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

func (*SpoonAPI) Init

func (o *SpoonAPI) Init()

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

func (*SpoonAPI) ProducersFor

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

ProducersFor gets the producers for the specified media types

func (*SpoonAPI) RegisterConsumer

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

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

func (*SpoonAPI) RegisterFormat

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

RegisterFormat registers a custom format validator

func (*SpoonAPI) RegisterProducer

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

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

func (*SpoonAPI) Serve

func (o *SpoonAPI) 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 (*SpoonAPI) ServeErrorFor

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

ServeErrorFor gets a error handler for a given operation id

func (*SpoonAPI) SetDefaultConsumes

func (o *SpoonAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*SpoonAPI) SetDefaultProduces

func (o *SpoonAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*SpoonAPI) SetSpec

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

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

func (*SpoonAPI) Validate

func (o *SpoonAPI) Validate() error

Validate validates the registrations in the SpoonAPI