Documentation
¶
Index ¶
- type TemplateForHTTPServerAPI
- func (o *TemplateForHTTPServerAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
- func (o *TemplateForHTTPServerAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *TemplateForHTTPServerAPI) Authorizer() runtime.Authorizer
- func (o *TemplateForHTTPServerAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *TemplateForHTTPServerAPI) Context() *middleware.Context
- func (o *TemplateForHTTPServerAPI) DefaultConsumes() string
- func (o *TemplateForHTTPServerAPI) DefaultProduces() string
- func (o *TemplateForHTTPServerAPI) Formats() strfmt.Registry
- func (o *TemplateForHTTPServerAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *TemplateForHTTPServerAPI) Init()
- func (o *TemplateForHTTPServerAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *TemplateForHTTPServerAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
- func (o *TemplateForHTTPServerAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *TemplateForHTTPServerAPI) RegisterProducer(mediaType string, producer runtime.Producer)
- func (o *TemplateForHTTPServerAPI) Serve(builder middleware.Builder) http.Handler
- func (o *TemplateForHTTPServerAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *TemplateForHTTPServerAPI) SetDefaultConsumes(mediaType string)
- func (o *TemplateForHTTPServerAPI) SetDefaultProduces(mediaType string)
- func (o *TemplateForHTTPServerAPI) SetSpec(spec *loads.Document)
- func (o *TemplateForHTTPServerAPI) UseRedoc()
- func (o *TemplateForHTTPServerAPI) UseSwaggerUI()
- func (o *TemplateForHTTPServerAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type TemplateForHTTPServerAPI ¶
type TemplateForHTTPServerAPI 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
// AddressGetAddressAgentHandler sets the operation handler for the get address agent operation
AddressGetAddressAgentHandler address.GetAddressAgentHandler
// ExecTaskGetExecuteTaskAgentHandler sets the operation handler for the get execute task agent operation
ExecTaskGetExecuteTaskAgentHandler exec_task.GetExecuteTaskAgentHandler
// GetTaskGetTaskTaskIDHandler sets the operation handler for the get task task ID operation
GetTaskGetTaskTaskIDHandler get_task.GetTaskTaskIDHandler
// VersionGetVersionHandler sets the operation handler for the get version operation
VersionGetVersionHandler version.GetVersionHandler
// RegAgentPostAgentHandler sets the operation handler for the post agent operation
RegAgentPostAgentHandler reg_agent.PostAgentHandler
// SetResultPostSetResultIDHandler sets the operation handler for the post set result ID operation
SetResultPostSetResultIDHandler set_result.PostSetResultIDHandler
// CreateTaskPostTaskHandler sets the operation handler for the post task operation
CreateTaskPostTaskHandler create_task.PostTaskHandler
// 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
}
TemplateForHTTPServerAPI API for test server
func NewTemplateForHTTPServerAPI ¶
func NewTemplateForHTTPServerAPI(spec *loads.Document) *TemplateForHTTPServerAPI
NewTemplateForHTTPServerAPI creates a new TemplateForHTTPServer instance
func (*TemplateForHTTPServerAPI) AddMiddlewareFor ¶
func (o *TemplateForHTTPServerAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
AddMiddlewareFor adds a http middleware to existing handler
func (*TemplateForHTTPServerAPI) AuthenticatorsFor ¶
func (o *TemplateForHTTPServerAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*TemplateForHTTPServerAPI) Authorizer ¶
func (o *TemplateForHTTPServerAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*TemplateForHTTPServerAPI) ConsumersFor ¶
func (o *TemplateForHTTPServerAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.
func (*TemplateForHTTPServerAPI) Context ¶
func (o *TemplateForHTTPServerAPI) Context() *middleware.Context
Context returns the middleware context for the template for HTTP server API
func (*TemplateForHTTPServerAPI) DefaultConsumes ¶
func (o *TemplateForHTTPServerAPI) DefaultConsumes() string
DefaultConsumes returns the default consumes media type
func (*TemplateForHTTPServerAPI) DefaultProduces ¶
func (o *TemplateForHTTPServerAPI) DefaultProduces() string
DefaultProduces returns the default produces media type
func (*TemplateForHTTPServerAPI) Formats ¶
func (o *TemplateForHTTPServerAPI) Formats() strfmt.Registry
Formats returns the registered string formats
func (*TemplateForHTTPServerAPI) HandlerFor ¶
func (o *TemplateForHTTPServerAPI) HandlerFor(method, path string) (http.Handler, bool)
HandlerFor gets a http.Handler for the provided operation method and path
func (*TemplateForHTTPServerAPI) Init ¶
func (o *TemplateForHTTPServerAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*TemplateForHTTPServerAPI) ProducersFor ¶
func (o *TemplateForHTTPServerAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.
func (*TemplateForHTTPServerAPI) RegisterConsumer ¶
func (o *TemplateForHTTPServerAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*TemplateForHTTPServerAPI) RegisterFormat ¶
func (o *TemplateForHTTPServerAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
RegisterFormat registers a custom format validator
func (*TemplateForHTTPServerAPI) RegisterProducer ¶
func (o *TemplateForHTTPServerAPI) RegisterProducer(mediaType string, producer runtime.Producer)
RegisterProducer allows you to add (or override) a producer for a media type.
func (*TemplateForHTTPServerAPI) Serve ¶
func (o *TemplateForHTTPServerAPI) 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 (*TemplateForHTTPServerAPI) ServeErrorFor ¶
func (o *TemplateForHTTPServerAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*TemplateForHTTPServerAPI) SetDefaultConsumes ¶
func (o *TemplateForHTTPServerAPI) SetDefaultConsumes(mediaType string)
SetDefaultConsumes returns the default consumes media type
func (*TemplateForHTTPServerAPI) SetDefaultProduces ¶
func (o *TemplateForHTTPServerAPI) SetDefaultProduces(mediaType string)
SetDefaultProduces sets the default produces media type
func (*TemplateForHTTPServerAPI) SetSpec ¶
func (o *TemplateForHTTPServerAPI) SetSpec(spec *loads.Document)
SetSpec sets a spec that will be served for the clients.
func (*TemplateForHTTPServerAPI) UseRedoc ¶
func (o *TemplateForHTTPServerAPI) UseRedoc()
UseRedoc for documentation at /docs
func (*TemplateForHTTPServerAPI) UseSwaggerUI ¶
func (o *TemplateForHTTPServerAPI) UseSwaggerUI()
UseSwaggerUI for documentation at /docs
func (*TemplateForHTTPServerAPI) Validate ¶
func (o *TemplateForHTTPServerAPI) Validate() error
Validate validates the registrations in the TemplateForHTTPServerAPI