hello

Documentation

Index

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

Types

type HelloAPI

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

	// ExampleHelloHandler sets the operation handler for the hello operation
	ExampleHelloHandler example.HelloHandler
	// 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
}

HelloAPI This is a sample server hello server.

func NewHelloAPI

func NewHelloAPI(spec *loads.Document) *HelloAPI

NewHelloAPI creates a new Hello instance

func (*HelloAPI) AddMiddlewareFor

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

AddMiddlewareFor adds a http middleware to existing handler

func (*HelloAPI) AuthenticatorsFor

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*HelloAPI) Authorizer

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

Authorizer returns the registered authorizer

func (*HelloAPI) ConsumersFor

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

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

func (*HelloAPI) Context

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

Context returns the middleware context for the hello API

func (*HelloAPI) DefaultConsumes

func (o *HelloAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*HelloAPI) DefaultProduces

func (o *HelloAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*HelloAPI) Formats

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

Formats returns the registered string formats

func (*HelloAPI) HandlerFor

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

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

func (*HelloAPI) Init

func (o *HelloAPI) Init()

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

func (*HelloAPI) ProducersFor

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

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

func (*HelloAPI) RegisterConsumer

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

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

func (*HelloAPI) RegisterFormat

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

RegisterFormat registers a custom format validator

func (*HelloAPI) RegisterProducer

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

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

func (*HelloAPI) Serve

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

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

ServeErrorFor gets a error handler for a given operation id

func (*HelloAPI) SetDefaultConsumes

func (o *HelloAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*HelloAPI) SetDefaultProduces

func (o *HelloAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*HelloAPI) SetSpec

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

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

func (*HelloAPI) UseRedoc

func (o *HelloAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*HelloAPI) UseSwaggerUI

func (o *HelloAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*HelloAPI) Validate

func (o *HelloAPI) Validate() error

Validate validates the registrations in the HelloAPI