Documentation
¶
Index ¶
- type SimpleToDoListAPIAPI
- func (o *SimpleToDoListAPIAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
- func (o *SimpleToDoListAPIAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *SimpleToDoListAPIAPI) Authorizer() runtime.Authorizer
- func (o *SimpleToDoListAPIAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *SimpleToDoListAPIAPI) Context() *middleware.Context
- func (o *SimpleToDoListAPIAPI) DefaultConsumes() string
- func (o *SimpleToDoListAPIAPI) DefaultProduces() string
- func (o *SimpleToDoListAPIAPI) Formats() strfmt.Registry
- func (o *SimpleToDoListAPIAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *SimpleToDoListAPIAPI) Init()
- func (o *SimpleToDoListAPIAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *SimpleToDoListAPIAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
- func (o *SimpleToDoListAPIAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *SimpleToDoListAPIAPI) RegisterProducer(mediaType string, producer runtime.Producer)
- func (o *SimpleToDoListAPIAPI) Serve(builder middleware.Builder) http.Handler
- func (o *SimpleToDoListAPIAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *SimpleToDoListAPIAPI) SetDefaultConsumes(mediaType string)
- func (o *SimpleToDoListAPIAPI) SetDefaultProduces(mediaType string)
- func (o *SimpleToDoListAPIAPI) SetSpec(spec *loads.Document)
- func (o *SimpleToDoListAPIAPI) UseRedoc()
- func (o *SimpleToDoListAPIAPI) UseSwaggerUI()
- func (o *SimpleToDoListAPIAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type SimpleToDoListAPIAPI ¶
type SimpleToDoListAPIAPI 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/io.swagger.examples.todo-list.v1+json
JSONConsumer runtime.Consumer
// JSONProducer registers a producer for the following mime types:
// - application/io.swagger.examples.todo-list.v1+json
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) (any, 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
TodosAddOneHandler todos.AddOneHandler
// TodosDestroyOneHandler sets the operation handler for the destroy one operation
TodosDestroyOneHandler todos.DestroyOneHandler
// TodosFindHandler sets the operation handler for the find operation
TodosFindHandler todos.FindHandler
// TodosUpdateOneHandler sets the operation handler for the update one operation
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)
// 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, ...any)
// contains filtered or unexported fields
}
SimpleToDoListAPIAPI This is a simple todo list API illustrating go-swagger codegen capabilities.
func NewSimpleToDoListAPIAPI ¶
func NewSimpleToDoListAPIAPI(spec *loads.Document) *SimpleToDoListAPIAPI
NewSimpleToDoListAPIAPI creates a new SimpleToDoListAPI instance
func (*SimpleToDoListAPIAPI) AddMiddlewareFor ¶
func (o *SimpleToDoListAPIAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
AddMiddlewareFor adds a http middleware to existing handler
func (*SimpleToDoListAPIAPI) AuthenticatorsFor ¶
func (o *SimpleToDoListAPIAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*SimpleToDoListAPIAPI) Authorizer ¶
func (o *SimpleToDoListAPIAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*SimpleToDoListAPIAPI) ConsumersFor ¶
func (o *SimpleToDoListAPIAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
ConsumersFor gets the consumers for the specified media types.
MIME type parameters are ignored here.
func (*SimpleToDoListAPIAPI) Context ¶
func (o *SimpleToDoListAPIAPI) Context() *middleware.Context
Context returns the middleware context for the simple to do list API API
func (*SimpleToDoListAPIAPI) DefaultConsumes ¶
func (o *SimpleToDoListAPIAPI) DefaultConsumes() string
DefaultConsumes returns the default consumes media type
func (*SimpleToDoListAPIAPI) DefaultProduces ¶
func (o *SimpleToDoListAPIAPI) DefaultProduces() string
DefaultProduces returns the default produces media type
func (*SimpleToDoListAPIAPI) Formats ¶
func (o *SimpleToDoListAPIAPI) Formats() strfmt.Registry
Formats returns the registered string formats
func (*SimpleToDoListAPIAPI) HandlerFor ¶
func (o *SimpleToDoListAPIAPI) HandlerFor(method, path string) (http.Handler, bool)
HandlerFor gets a http.Handler for the provided operation method and path
func (*SimpleToDoListAPIAPI) Init ¶
func (o *SimpleToDoListAPIAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*SimpleToDoListAPIAPI) ProducersFor ¶
func (o *SimpleToDoListAPIAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
ProducersFor gets the producers for the specified media types.
MIME type parameters are ignored here.
func (*SimpleToDoListAPIAPI) RegisterConsumer ¶
func (o *SimpleToDoListAPIAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*SimpleToDoListAPIAPI) RegisterFormat ¶
func (o *SimpleToDoListAPIAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
RegisterFormat registers a custom format validator
func (*SimpleToDoListAPIAPI) RegisterProducer ¶
func (o *SimpleToDoListAPIAPI) RegisterProducer(mediaType string, producer runtime.Producer)
RegisterProducer allows you to add (or override) a producer for a media type.
func (*SimpleToDoListAPIAPI) Serve ¶
func (o *SimpleToDoListAPIAPI) 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 (*SimpleToDoListAPIAPI) ServeErrorFor ¶
func (o *SimpleToDoListAPIAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*SimpleToDoListAPIAPI) SetDefaultConsumes ¶
func (o *SimpleToDoListAPIAPI) SetDefaultConsumes(mediaType string)
SetDefaultConsumes returns the default consumes media type
func (*SimpleToDoListAPIAPI) SetDefaultProduces ¶
func (o *SimpleToDoListAPIAPI) SetDefaultProduces(mediaType string)
SetDefaultProduces sets the default produces media type
func (*SimpleToDoListAPIAPI) SetSpec ¶
func (o *SimpleToDoListAPIAPI) SetSpec(spec *loads.Document)
SetSpec sets a spec that will be served for the clients.
func (*SimpleToDoListAPIAPI) UseRedoc ¶
func (o *SimpleToDoListAPIAPI) UseRedoc()
UseRedoc for documentation at /docs
func (*SimpleToDoListAPIAPI) UseSwaggerUI ¶
func (o *SimpleToDoListAPIAPI) UseSwaggerUI()
UseSwaggerUI for documentation at /docs
func (*SimpleToDoListAPIAPI) Validate ¶
func (o *SimpleToDoListAPIAPI) Validate() error
Validate validates the registrations in the SimpleToDoListAPIAPI
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.