Documentation
¶
Index ¶
- type API
- func (d *API) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (d *API) Authorizer() runtime.Authorizer
- func (d *API) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (d *API) Formats() strfmt.Registry
- func (d *API) OperationHandlerFor(method, path string) (runtime.OperationHandler, bool)
- func (d *API) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (d *API) RegisterAuth(scheme string, handler runtime.Authenticator)
- func (d *API) RegisterAuthorizer(handler runtime.Authorizer)
- func (d *API) RegisterConsumer(mediaType string, handler runtime.Consumer)
- func (d *API) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (d *API) RegisterOperation(method, path string, handler runtime.OperationHandler)
- func (d *API) RegisterProducer(mediaType string, handler runtime.Producer)
- func (d *API) Validate() error
- func (d *API) WithJSONDefaults() *API
- func (d *API) WithoutJSONDefaults() *API
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type API ¶
type API struct {
DefaultProduces string
DefaultConsumes string
ServeError func(http.ResponseWriter, *http.Request, error)
Models map[string]func() any
// contains filtered or unexported fields
}
API represents an untyped mux for a swagger spec.
func (*API) AuthenticatorsFor ¶
func (d *API) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes.
func (*API) Authorizer ¶
func (d *API) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer.
func (*API) ConsumersFor ¶
ConsumersFor gets the consumers for the specified media types.
func (*API) OperationHandlerFor ¶
func (d *API) OperationHandlerFor(method, path string) (runtime.OperationHandler, bool)
OperationHandlerFor returns the operation handler for the specified id if it can be found.
func (*API) ProducersFor ¶
ProducersFor gets the producers for the specified media types.
func (*API) RegisterAuth ¶
func (d *API) RegisterAuth(scheme string, handler runtime.Authenticator)
RegisterAuth registers an auth handler in this api.
func (*API) RegisterAuthorizer ¶
func (d *API) RegisterAuthorizer(handler runtime.Authorizer)
RegisterAuthorizer registers an authorizer handler in this api.
func (*API) RegisterConsumer ¶
RegisterConsumer registers a consumer for a media type.
func (*API) RegisterFormat ¶
RegisterFormat registers a custom format validator.
func (*API) RegisterOperation ¶
func (d *API) RegisterOperation(method, path string, handler runtime.OperationHandler)
RegisterOperation registers an operation handler for an operation name.
func (*API) RegisterProducer ¶
RegisterProducer registers a producer for a media type.
func (*API) WithJSONDefaults ¶
WithJSONDefaults loads the json defaults for this api.
func (*API) WithoutJSONDefaults ¶
WithoutJSONDefaults clears the json defaults for this api.
Source Files