Documentation ¶
Index ¶
- type FlamedbAPI
- func (o *FlamedbAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *FlamedbAPI) Authorizer() runtime.Authorizer
- func (o *FlamedbAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *FlamedbAPI) Context() *middleware.Context
- func (o *FlamedbAPI) DefaultConsumes() string
- func (o *FlamedbAPI) DefaultProduces() string
- func (o *FlamedbAPI) Formats() strfmt.Registry
- func (o *FlamedbAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *FlamedbAPI) Init()
- func (o *FlamedbAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *FlamedbAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
- func (o *FlamedbAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *FlamedbAPI) RegisterProducer(mediaType string, producer runtime.Producer)
- func (o *FlamedbAPI) Serve(builder middleware.Builder) http.Handler
- func (o *FlamedbAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *FlamedbAPI) SetDefaultConsumes(mediaType string)
- func (o *FlamedbAPI) SetDefaultProduces(mediaType string)
- func (o *FlamedbAPI) SetSpec(spec *loads.Document)
- func (o *FlamedbAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FlamedbAPI ¶
type FlamedbAPI 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 // BasicAuthAuth registers a function that takes username and password and returns a principal // it performs authentication with basic auth BasicAuthAuth func(string, string) (*models.Principal, error) // FlamedbAuthAuth registers a function that takes a token and returns a principal // it performs authentication based on an api key Authorization provided in the header FlamedbAuthAuth func(string) (*models.Principal, error) // APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal APIAuthorizer runtime.Authorizer // RecordsCreateRecordHandler sets the operation handler for the create record operation RecordsCreateRecordHandler records.CreateRecordHandler // RecordsDeleteRecordHandler sets the operation handler for the delete record operation RecordsDeleteRecordHandler records.DeleteRecordHandler // RecordsFindRecordHandler sets the operation handler for the find record operation RecordsFindRecordHandler records.FindRecordHandler // RecordsGetRecordHandler sets the operation handler for the get record operation RecordsGetRecordHandler records.GetRecordHandler // RecordsListRecordsHandler sets the operation handler for the list records operation RecordsListRecordsHandler records.ListRecordsHandler // RecordsUpdateRecordHandler sets the operation handler for the update record operation RecordsUpdateRecordHandler records.UpdateRecordHandler // 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 }
FlamedbAPI FlameDB HTTP API
func NewFlamedbAPI ¶
func NewFlamedbAPI(spec *loads.Document) *FlamedbAPI
NewFlamedbAPI creates a new Flamedb instance
func (*FlamedbAPI) AuthenticatorsFor ¶
func (o *FlamedbAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*FlamedbAPI) Authorizer ¶
func (o *FlamedbAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*FlamedbAPI) ConsumersFor ¶
func (o *FlamedbAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
ConsumersFor gets the consumers for the specified media types
func (*FlamedbAPI) Context ¶
func (o *FlamedbAPI) Context() *middleware.Context
Context returns the middleware context for the flamedb API
func (*FlamedbAPI) DefaultConsumes ¶
func (o *FlamedbAPI) DefaultConsumes() string
DefaultConsumes returns the default consumes media type
func (*FlamedbAPI) DefaultProduces ¶
func (o *FlamedbAPI) DefaultProduces() string
DefaultProduces returns the default produces media type
func (*FlamedbAPI) Formats ¶
func (o *FlamedbAPI) Formats() strfmt.Registry
Formats returns the registered string formats
func (*FlamedbAPI) HandlerFor ¶
func (o *FlamedbAPI) HandlerFor(method, path string) (http.Handler, bool)
HandlerFor gets a http.Handler for the provided operation method and path
func (*FlamedbAPI) Init ¶
func (o *FlamedbAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*FlamedbAPI) ProducersFor ¶
func (o *FlamedbAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
ProducersFor gets the producers for the specified media types
func (*FlamedbAPI) RegisterConsumer ¶
func (o *FlamedbAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*FlamedbAPI) RegisterFormat ¶
RegisterFormat registers a custom format validator
func (*FlamedbAPI) RegisterProducer ¶
func (o *FlamedbAPI) RegisterProducer(mediaType string, producer runtime.Producer)
RegisterProducer allows you to add (or override) a producer for a media type.
func (*FlamedbAPI) Serve ¶
func (o *FlamedbAPI) 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 (*FlamedbAPI) ServeErrorFor ¶
func (o *FlamedbAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*FlamedbAPI) SetDefaultConsumes ¶
func (o *FlamedbAPI) SetDefaultConsumes(mediaType string)
SetDefaultConsumes returns the default consumes media type
func (*FlamedbAPI) SetDefaultProduces ¶
func (o *FlamedbAPI) SetDefaultProduces(mediaType string)
SetDefaultProduces sets the default produces media type
func (*FlamedbAPI) SetSpec ¶
func (o *FlamedbAPI) SetSpec(spec *loads.Document)
SetSpec sets a spec that will be served for the clients.
func (*FlamedbAPI) Validate ¶
func (o *FlamedbAPI) Validate() error
Validate validates the registrations in the FlamedbAPI