import "github.com/go-swagger/go-swagger/examples/authentication/restapi/operations"
type AuthSampleAPI 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/keyauth.api.v1+json
JSONConsumer runtime.Consumer
// JSONProducer registers a producer for the following mime types:
// - application/keyauth.api.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-token provided in the header
KeyAuth func(string) (*models.Principal, error)
// APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal
APIAuthorizer runtime.Authorizer
// CustomersCreateHandler sets the operation handler for the create operation
CustomersCreateHandler customers.CreateHandler
// CustomersGetIDHandler sets the operation handler for the get Id operation
CustomersGetIDHandler customers.GetIDHandler
// 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
}AuthSampleAPI the auth sample API
func NewAuthSampleAPI(spec *loads.Document) *AuthSampleAPI
NewAuthSampleAPI creates a new AuthSample instance
func (o *AuthSampleAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
AddMiddlewareFor adds a http middleware to existing handler
func (o *AuthSampleAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (o *AuthSampleAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.
func (o *AuthSampleAPI) Context() *middleware.Context
Context returns the middleware context for the auth sample API
func (o *AuthSampleAPI) DefaultConsumes() string
DefaultConsumes returns the default consumes media type
func (o *AuthSampleAPI) DefaultProduces() string
DefaultProduces returns the default produces media type
func (o *AuthSampleAPI) Formats() strfmt.Registry
Formats returns the registered string formats
HandlerFor gets a http.Handler for the provided operation method and path
func (o *AuthSampleAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.
func (o *AuthSampleAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (o *AuthSampleAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
RegisterFormat registers a custom format validator
func (o *AuthSampleAPI) RegisterProducer(mediaType string, producer runtime.Producer)
RegisterProducer allows you to add (or override) a producer for a media type.
func (o *AuthSampleAPI) 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 (o *AuthSampleAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (o *AuthSampleAPI) SetDefaultConsumes(mediaType string)
SetDefaultConsumes returns the default consumes media type
func (o *AuthSampleAPI) SetDefaultProduces(mediaType string)
SetDefaultProduces sets the default produces media type
func (o *AuthSampleAPI) SetSpec(spec *loads.Document)
SetSpec sets a spec that will be served for the clients.
func (o *AuthSampleAPI) UseRedoc()
UseRedoc for documentation at /docs
func (o *AuthSampleAPI) UseSwaggerUI()
UseSwaggerUI for documentation at /docs
func (o *AuthSampleAPI) Validate() error
Validate validates the registrations in the AuthSampleAPI
| Path | Synopsis |
|---|---|
| customers |
Package operations imports 13 packages (graph) and is imported by 2 packages. Updated 2021-01-26. Refresh now. Tools for package owners.