Documentation
¶
Index ¶
- type ServeAPI
- func (o *ServeAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
- func (o *ServeAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *ServeAPI) Authorizer() runtime.Authorizer
- func (o *ServeAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *ServeAPI) Context() *middleware.Context
- func (o *ServeAPI) DefaultConsumes() string
- func (o *ServeAPI) DefaultProduces() string
- func (o *ServeAPI) Formats() strfmt.Registry
- func (o *ServeAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *ServeAPI) Init()
- func (o *ServeAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *ServeAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
- func (o *ServeAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *ServeAPI) RegisterProducer(mediaType string, producer runtime.Producer)
- func (o *ServeAPI) Serve(builder middleware.Builder) http.Handler
- func (o *ServeAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *ServeAPI) SetDefaultConsumes(mediaType string)
- func (o *ServeAPI) SetDefaultProduces(mediaType string)
- func (o *ServeAPI) SetSpec(spec *loads.Document)
- func (o *ServeAPI) UseRedoc()
- func (o *ServeAPI) UseSwaggerUI()
- func (o *ServeAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ServeAPI ¶
type ServeAPI 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
// TxtConsumer registers a consumer for the following mime types:
// - text/plain
TxtConsumer runtime.Consumer
// JSONProducer registers a producer for the following mime types:
// - application/json
JSONProducer runtime.Producer
// TxtProducer registers a producer for the following mime types:
// - text/plain
TxtProducer 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
// UsersAddGroupForUserHandler sets the operation handler for the add group for user operation
UsersAddGroupForUserHandler users.AddGroupForUserHandler
// UsersCancelBookingHandler sets the operation handler for the cancel booking operation
UsersCancelBookingHandler users.CancelBookingHandler
// AdminCheckManifestHandler sets the operation handler for the check manifest operation
AdminCheckManifestHandler admin.CheckManifestHandler
// AdminExportBookingsHandler sets the operation handler for the export bookings operation
AdminExportBookingsHandler admin.ExportBookingsHandler
// AdminExportManifestHandler sets the operation handler for the export manifest operation
AdminExportManifestHandler admin.ExportManifestHandler
// AdminExportOldBookingsHandler sets the operation handler for the export old bookings operation
AdminExportOldBookingsHandler admin.ExportOldBookingsHandler
// AdminExportUsersHandler sets the operation handler for the export users operation
AdminExportUsersHandler admin.ExportUsersHandler
// UsersGetAccessTokenHandler sets the operation handler for the get access token operation
UsersGetAccessTokenHandler users.GetAccessTokenHandler
// UsersGetActivityHandler sets the operation handler for the get activity operation
UsersGetActivityHandler users.GetActivityHandler
// UsersGetAvailabilityHandler sets the operation handler for the get availability operation
UsersGetAvailabilityHandler users.GetAvailabilityHandler
// UsersGetBookingsForUserHandler sets the operation handler for the get bookings for user operation
UsersGetBookingsForUserHandler users.GetBookingsForUserHandler
// UsersGetDescriptionHandler sets the operation handler for the get description operation
UsersGetDescriptionHandler users.GetDescriptionHandler
// UsersGetGroupHandler sets the operation handler for the get group operation
UsersGetGroupHandler users.GetGroupHandler
// UsersGetGroupsForUserHandler sets the operation handler for the get groups for user operation
UsersGetGroupsForUserHandler users.GetGroupsForUserHandler
// UsersGetOldBookingsForUserHandler sets the operation handler for the get old bookings for user operation
UsersGetOldBookingsForUserHandler users.GetOldBookingsForUserHandler
// UsersGetPolicyHandler sets the operation handler for the get policy operation
UsersGetPolicyHandler users.GetPolicyHandler
// UsersGetPolicyStatusForUserHandler sets the operation handler for the get policy status for user operation
UsersGetPolicyStatusForUserHandler users.GetPolicyStatusForUserHandler
// AdminGetResourceIsAvailableHandler sets the operation handler for the get resource is available operation
AdminGetResourceIsAvailableHandler admin.GetResourceIsAvailableHandler
// AdminGetResourcesHandler sets the operation handler for the get resources operation
AdminGetResourcesHandler admin.GetResourcesHandler
// AdminGetSlotIsAvailableHandler sets the operation handler for the get slot is available operation
AdminGetSlotIsAvailableHandler admin.GetSlotIsAvailableHandler
// UsersMakeBookingHandler sets the operation handler for the make booking operation
UsersMakeBookingHandler users.MakeBookingHandler
// AdminReplaceBookingsHandler sets the operation handler for the replace bookings operation
AdminReplaceBookingsHandler admin.ReplaceBookingsHandler
// AdminReplaceManifestHandler sets the operation handler for the replace manifest operation
AdminReplaceManifestHandler admin.ReplaceManifestHandler
// AdminReplaceOldBookingsHandler sets the operation handler for the replace old bookings operation
AdminReplaceOldBookingsHandler admin.ReplaceOldBookingsHandler
// AdminSetResourceIsAvailableHandler sets the operation handler for the set resource is available operation
AdminSetResourceIsAvailableHandler admin.SetResourceIsAvailableHandler
// AdminSetSlotIsAvailableHandler sets the operation handler for the set slot is available operation
AdminSetSlotIsAvailableHandler admin.SetSlotIsAvailableHandler
// UsersUniqueNameHandler sets the operation handler for the unique name operation
UsersUniqueNameHandler users.UniqueNameHandler
// AdminGetStoreStatusAdminHandler sets the operation handler for the get store status admin operation
AdminGetStoreStatusAdminHandler admin.GetStoreStatusAdminHandler
// UsersGetStoreStatusUserHandler sets the operation handler for the get store status user operation
UsersGetStoreStatusUserHandler users.GetStoreStatusUserHandler
// AdminSetLockHandler sets the operation handler for the set lock operation
AdminSetLockHandler admin.SetLockHandler
// 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
}
ServeAPI User API for booking slots in advance
func NewServeAPI ¶
NewServeAPI creates a new Serve instance
func (*ServeAPI) AddMiddlewareFor ¶
func (o *ServeAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
AddMiddlewareFor adds a http middleware to existing handler
func (*ServeAPI) AuthenticatorsFor ¶
func (o *ServeAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*ServeAPI) Authorizer ¶
func (o *ServeAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*ServeAPI) ConsumersFor ¶
ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.
func (*ServeAPI) Context ¶
func (o *ServeAPI) Context() *middleware.Context
Context returns the middleware context for the serve API
func (*ServeAPI) DefaultConsumes ¶
DefaultConsumes returns the default consumes media type
func (*ServeAPI) DefaultProduces ¶
DefaultProduces returns the default produces media type
func (*ServeAPI) HandlerFor ¶
HandlerFor gets a http.Handler for the provided operation method and path
func (*ServeAPI) Init ¶
func (o *ServeAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*ServeAPI) ProducersFor ¶
ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.
func (*ServeAPI) RegisterConsumer ¶
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*ServeAPI) RegisterFormat ¶
RegisterFormat registers a custom format validator
func (*ServeAPI) RegisterProducer ¶
RegisterProducer allows you to add (or override) a producer for a media type.
func (*ServeAPI) Serve ¶
func (o *ServeAPI) 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 (*ServeAPI) ServeErrorFor ¶
func (o *ServeAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*ServeAPI) SetDefaultConsumes ¶
SetDefaultConsumes returns the default consumes media type
func (*ServeAPI) SetDefaultProduces ¶
SetDefaultProduces sets the default produces media type
func (*ServeAPI) UseSwaggerUI ¶
func (o *ServeAPI) UseSwaggerUI()
UseSwaggerUI for documentation at /docs