operations

Documentation

Index

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

Types

type OasV2API

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

	// MonitoringUnsecuredPingHandler sets the operation handler for the unsecured ping operation
	MonitoringUnsecuredPingHandler monitoring.UnsecuredPingHandler

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

OasV2API Golang's craft openapi v2 example

func NewOasV2API

func NewOasV2API(spec *loads.Document) *OasV2API

NewOasV2API creates a new OasV2 instance

func (*OasV2API) AddMiddlewareFor

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

AddMiddlewareFor adds a http middleware to existing handler

func (*OasV2API) AuthenticatorsFor

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*OasV2API) Authorizer

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

Authorizer returns the registered authorizer

func (*OasV2API) ConsumersFor

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

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

func (*OasV2API) Context

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

Context returns the middleware context for the oas v2 API

func (*OasV2API) DefaultConsumes

func (o *OasV2API) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*OasV2API) DefaultProduces

func (o *OasV2API) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*OasV2API) Formats

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

Formats returns the registered string formats

func (*OasV2API) HandlerFor

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

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

func (*OasV2API) Init

func (o *OasV2API) Init()

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

func (*OasV2API) ProducersFor

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

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

func (*OasV2API) RegisterConsumer

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

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

func (*OasV2API) RegisterFormat

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

RegisterFormat registers a custom format validator

func (*OasV2API) RegisterProducer

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

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

func (*OasV2API) Serve

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

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

ServeErrorFor gets a error handler for a given operation id

func (*OasV2API) SetDefaultConsumes

func (o *OasV2API) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*OasV2API) SetDefaultProduces

func (o *OasV2API) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*OasV2API) SetSpec

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

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

func (*OasV2API) UseRedoc

func (o *OasV2API) UseRedoc()

UseRedoc for documentation at /docs

func (*OasV2API) UseSwaggerUI

func (o *OasV2API) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*OasV2API) Validate

func (o *OasV2API) Validate() error

Validate validates the registrations in the OasV2API