Documentation ¶
Index ¶
- type API
- func (o *API) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *API) Authorizer() runtime.Authorizer
- func (o *API) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *API) Context() *middleware.Context
- func (o *API) DefaultConsumes() string
- func (o *API) DefaultProduces() string
- func (o *API) Formats() strfmt.Registry
- func (o *API) HandlerFor(method, path string) (http.Handler, bool)
- func (o *API) Init()
- func (o *API) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *API) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *API) Serve(builder middleware.Builder) http.Handler
- func (o *API) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *API) SetDefaultConsumes(mediaType string)
- func (o *API) SetDefaultProduces(mediaType string)
- func (o *API) SetSpec(spec *loads.Document)
- func (o *API) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type API ¶
type API 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 // IPFSArchiveURLHandler sets the operation handler for the archive Url operation IPFSArchiveURLHandler ipfs.ArchiveURLHandler // 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 }
API The web api for ipfs-archive
func (*API) AuthenticatorsFor ¶
func (o *API) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*API) Authorizer ¶
func (o *API) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*API) ConsumersFor ¶
ConsumersFor gets the consumers for the specified media types
func (*API) Context ¶
func (o *API) Context() *middleware.Context
Context returns the middleware context for the API
func (*API) DefaultConsumes ¶
DefaultConsumes returns the default consumes media type
func (*API) DefaultProduces ¶
DefaultProduces returns the default produces media type
func (*API) HandlerFor ¶
HandlerFor gets a http.Handler for the provided operation method and path
func (*API) Init ¶
func (o *API) Init()
Init allows you to just initialize the handler cache, you can then recompose the middelware as you see fit
func (*API) ProducersFor ¶
ProducersFor gets the producers for the specified media types
func (*API) RegisterFormat ¶
RegisterFormat registers a custom format validator
func (*API) Serve ¶
func (o *API) 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 (*API) ServeErrorFor ¶
ServeErrorFor gets a error handler for a given operation id
func (*API) SetDefaultConsumes ¶
SetDefaultConsumes returns the default consumes media type
func (*API) SetDefaultProduces ¶
SetDefaultProduces sets the default produces media type