Documentation ¶
Index ¶
- type TodoAPI
- func (o *TodoAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *TodoAPI) Authorizer() runtime.Authorizer
- func (o *TodoAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *TodoAPI) Context() *middleware.Context
- func (o *TodoAPI) DefaultConsumes() string
- func (o *TodoAPI) DefaultProduces() string
- func (o *TodoAPI) Formats() strfmt.Registry
- func (o *TodoAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *TodoAPI) Init()
- func (o *TodoAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *TodoAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
- func (o *TodoAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *TodoAPI) RegisterProducer(mediaType string, producer runtime.Producer)
- func (o *TodoAPI) Serve(builder middleware.Builder) http.Handler
- func (o *TodoAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *TodoAPI) SetDefaultConsumes(mediaType string)
- func (o *TodoAPI) SetDefaultProduces(mediaType string)
- func (o *TodoAPI) SetSpec(spec *loads.Document)
- func (o *TodoAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type TodoAPI ¶
type TodoAPI 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 a "application/io.swagger.examples.todo-list.v1+json" mime type JSONConsumer runtime.Consumer // JSONProducer registers a producer for a "application/io.swagger.examples.todo-list.v1+json" mime type JSONProducer runtime.Producer // KeyAuth registers a function that takes a token and returns a principal // it performs authentication based on an api key x-todolist-token provided in the header KeyAuth func(string) (interface{}, error) // APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal APIAuthorizer runtime.Authorizer // TodosAddOneHandler sets the operation handler for the add one operation // POST / TodosAddOneHandler todos.AddOneHandler // TodosDestroyOneHandler sets the operation handler for the destroy one operation // DELETE /{id} TodosDestroyOneHandler todos.DestroyOneHandler // TodosFindHandler sets the operation handler for the find operation // GET / TodosFindHandler todos.FindHandler // TodosUpdateOneHandler sets the operation handler for the update one operation // PUT /{id} TodosUpdateOneHandler todos.UpdateOneHandler // 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 }
TodoAPI the todo API
func NewTodoAPI ¶
NewTodoAPI creates a new Todo instance
func (*TodoAPI) AuthenticatorsFor ¶
func (o *TodoAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*TodoAPI) Authorizer ¶
func (o *TodoAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*TodoAPI) ConsumersFor ¶
ConsumersFor gets the consumers for the specified media types
func (*TodoAPI) Context ¶
func (o *TodoAPI) Context() *middleware.Context
Context returns the middleware context for the todo API
func (*TodoAPI) DefaultConsumes ¶
DefaultConsumes returns the default consumes media type
func (*TodoAPI) DefaultProduces ¶
DefaultProduces returns the default produces media type
func (*TodoAPI) HandlerFor ¶
HandlerFor gets a http.Handler for the provided operation method and path
func (*TodoAPI) Init ¶
func (o *TodoAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*TodoAPI) ProducersFor ¶
ProducersFor gets the producers for the specified media types
func (*TodoAPI) RegisterConsumer ¶
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*TodoAPI) RegisterFormat ¶
RegisterFormat registers a custom format validator
func (*TodoAPI) RegisterProducer ¶
RegisterProducer allows you to add (or override) a producer for a media type.
func (*TodoAPI) Serve ¶
func (o *TodoAPI) 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 (*TodoAPI) ServeErrorFor ¶
ServeErrorFor gets a error handler for a given operation id
func (*TodoAPI) SetDefaultConsumes ¶
SetDefaultConsumes returns the default consumes media type
func (*TodoAPI) SetDefaultProduces ¶
SetDefaultProduces sets the default produces media type