Documentation
¶
Index ¶
- type AdminAPI
- func (o *AdminAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
- func (o *AdminAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *AdminAPI) Authorizer() runtime.Authorizer
- func (o *AdminAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *AdminAPI) Context() *middleware.Context
- func (o *AdminAPI) DefaultConsumes() string
- func (o *AdminAPI) DefaultProduces() string
- func (o *AdminAPI) Formats() strfmt.Registry
- func (o *AdminAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *AdminAPI) Init()
- func (o *AdminAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *AdminAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
- func (o *AdminAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *AdminAPI) RegisterProducer(mediaType string, producer runtime.Producer)
- func (o *AdminAPI) Serve(builder middleware.Builder) http.Handler
- func (o *AdminAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *AdminAPI) SetDefaultConsumes(mediaType string)
- func (o *AdminAPI) SetDefaultProduces(mediaType string)
- func (o *AdminAPI) SetSpec(spec *loads.Document)
- func (o *AdminAPI) UseRedoc()
- func (o *AdminAPI) UseSwaggerUI()
- func (o *AdminAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AdminAPI ¶
type AdminAPI 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
// BearerAuth registers a function that takes a token and returns a principal
// it performs authentication based on an api key Authorization provided in the header
BearerAuth func(string) (interface{}, error)
// APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal
APIAuthorizer runtime.Authorizer
// AccountsCreateAccountHandler sets the operation handler for the create account operation
AccountsCreateAccountHandler accounts.CreateAccountHandler
// LinksCreateLinkHandler sets the operation handler for the create link operation
LinksCreateLinkHandler links.CreateLinkHandler
// GeneralHealthcheckHandler sets the operation handler for the healthcheck operation
GeneralHealthcheckHandler general.HealthcheckHandler
// GeneralLoginHandler sets the operation handler for the login operation
GeneralLoginHandler general.LoginHandler
// AccountsUpdateAccountHandler sets the operation handler for the update account operation
AccountsUpdateAccountHandler accounts.UpdateAccountHandler
// LinksUpdateLinkHandler sets the operation handler for the update link operation
LinksUpdateLinkHandler links.UpdateLinkHandler
// 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
}
AdminAPI the admin API
func NewAdminAPI ¶
NewAdminAPI creates a new Admin instance
func (*AdminAPI) AddMiddlewareFor ¶
func (o *AdminAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
AddMiddlewareFor adds a http middleware to existing handler
func (*AdminAPI) AuthenticatorsFor ¶
func (o *AdminAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*AdminAPI) Authorizer ¶
func (o *AdminAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*AdminAPI) ConsumersFor ¶
ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.
func (*AdminAPI) Context ¶
func (o *AdminAPI) Context() *middleware.Context
Context returns the middleware context for the admin API
func (*AdminAPI) DefaultConsumes ¶
DefaultConsumes returns the default consumes media type
func (*AdminAPI) DefaultProduces ¶
DefaultProduces returns the default produces media type
func (*AdminAPI) HandlerFor ¶
HandlerFor gets a http.Handler for the provided operation method and path
func (*AdminAPI) Init ¶
func (o *AdminAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*AdminAPI) ProducersFor ¶
ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.
func (*AdminAPI) RegisterConsumer ¶
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*AdminAPI) RegisterFormat ¶
RegisterFormat registers a custom format validator
func (*AdminAPI) RegisterProducer ¶
RegisterProducer allows you to add (or override) a producer for a media type.
func (*AdminAPI) Serve ¶
func (o *AdminAPI) 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 (*AdminAPI) ServeErrorFor ¶
func (o *AdminAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*AdminAPI) SetDefaultConsumes ¶
SetDefaultConsumes returns the default consumes media type
func (*AdminAPI) SetDefaultProduces ¶
SetDefaultProduces sets the default produces media type
func (*AdminAPI) UseSwaggerUI ¶
func (o *AdminAPI) UseSwaggerUI()
UseSwaggerUI for documentation at /docs