Documentation
¶
Index ¶
- type SquashAPI
- func (o *SquashAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *SquashAPI) Authorizer() runtime.Authorizer
- func (o *SquashAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *SquashAPI) Context() *middleware.Context
- func (o *SquashAPI) DefaultConsumes() string
- func (o *SquashAPI) DefaultProduces() string
- func (o *SquashAPI) Formats() strfmt.Registry
- func (o *SquashAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *SquashAPI) Init()
- func (o *SquashAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *SquashAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *SquashAPI) Serve(builder middleware.Builder) http.Handler
- func (o *SquashAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *SquashAPI) SetDefaultConsumes(mediaType string)
- func (o *SquashAPI) SetDefaultProduces(mediaType string)
- func (o *SquashAPI) SetSpec(spec *loads.Document)
- func (o *SquashAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type SquashAPI ¶
type SquashAPI struct {
Middleware func(middleware.Builder) http.Handler
// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
// It has a default implemention 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 implemention 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 implemention 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/json" mime type
JSONConsumer runtime.Consumer
// JSONProducer registers a producer for a "application/json" mime type
JSONProducer runtime.Producer
// DebugattachmentAddDebugAttachmentHandler sets the operation handler for the add debug attachment operation
DebugattachmentAddDebugAttachmentHandler debugattachment.AddDebugAttachmentHandler
// DebugrequestCreateDebugRequestHandler sets the operation handler for the create debug request operation
DebugrequestCreateDebugRequestHandler debugrequest.CreateDebugRequestHandler
// DebugattachmentDeleteDebugAttachmentHandler sets the operation handler for the delete debug attachment operation
DebugattachmentDeleteDebugAttachmentHandler debugattachment.DeleteDebugAttachmentHandler
// DebugrequestDeleteDebugRequestHandler sets the operation handler for the delete debug request operation
DebugrequestDeleteDebugRequestHandler debugrequest.DeleteDebugRequestHandler
// DebugattachmentGetDebugAttachmentHandler sets the operation handler for the get debug attachment operation
DebugattachmentGetDebugAttachmentHandler debugattachment.GetDebugAttachmentHandler
// DebugattachmentGetDebugAttachmentsHandler sets the operation handler for the get debug attachments operation
DebugattachmentGetDebugAttachmentsHandler debugattachment.GetDebugAttachmentsHandler
// DebugrequestGetDebugRequestHandler sets the operation handler for the get debug request operation
DebugrequestGetDebugRequestHandler debugrequest.GetDebugRequestHandler
// DebugrequestGetDebugRequestsHandler sets the operation handler for the get debug requests operation
DebugrequestGetDebugRequestsHandler debugrequest.GetDebugRequestsHandler
// DebugattachmentPatchDebugAttachmentHandler sets the operation handler for the patch debug attachment operation
DebugattachmentPatchDebugAttachmentHandler debugattachment.PatchDebugAttachmentHandler
// 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
}
SquashAPI Squash debugger api.
func NewSquashAPI ¶
NewSquashAPI creates a new Squash instance
func (*SquashAPI) AuthenticatorsFor ¶
func (o *SquashAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*SquashAPI) Authorizer ¶ added in v0.2.0
func (o *SquashAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*SquashAPI) ConsumersFor ¶
ConsumersFor gets the consumers for the specified media types
func (*SquashAPI) Context ¶
func (o *SquashAPI) Context() *middleware.Context
Context returns the middleware context for the squash API
func (*SquashAPI) DefaultConsumes ¶
DefaultConsumes returns the default consumes media type
func (*SquashAPI) DefaultProduces ¶
DefaultProduces returns the default produces media type
func (*SquashAPI) HandlerFor ¶
HandlerFor gets a http.Handler for the provided operation method and path
func (*SquashAPI) Init ¶
func (o *SquashAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middelware as you see fit
func (*SquashAPI) ProducersFor ¶
ProducersFor gets the producers for the specified media types
func (*SquashAPI) RegisterFormat ¶
RegisterFormat registers a custom format validator
func (*SquashAPI) Serve ¶
func (o *SquashAPI) 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 (*SquashAPI) ServeErrorFor ¶
func (o *SquashAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*SquashAPI) SetDefaultConsumes ¶
SetDefaultConsumes returns the default consumes media type
func (*SquashAPI) SetDefaultProduces ¶
SetDefaultProduces sets the default produces media type