import "github.com/go-swagger/go-swagger/examples/task-tracker/restapi/operations"
type TaskTrackerAPI 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/vnd.goswagger.examples.task-tracker.v1+json JSONConsumer runtime.Consumer // MultipartformConsumer registers a consumer for the following mime types: // - multipart/form-data MultipartformConsumer runtime.Consumer // JSONProducer registers a producer for the following mime types: // - application/vnd.goswagger.examples.task-tracker.v1+json JSONProducer runtime.Producer // APIKeyAuth registers a function that takes a token and returns a principal // it performs authentication based on an api key token provided in the query APIKeyAuth func(string) (interface{}, error) // TokenHeaderAuth 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 TokenHeaderAuth func(string) (interface{}, error) // APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal APIAuthorizer runtime.Authorizer // TasksAddCommentToTaskHandler sets the operation handler for the add comment to task operation TasksAddCommentToTaskHandler tasks.AddCommentToTaskHandler // TasksCreateTaskHandler sets the operation handler for the create task operation TasksCreateTaskHandler tasks.CreateTaskHandler // TasksDeleteTaskHandler sets the operation handler for the delete task operation TasksDeleteTaskHandler tasks.DeleteTaskHandler // TasksGetTaskCommentsHandler sets the operation handler for the get task comments operation TasksGetTaskCommentsHandler tasks.GetTaskCommentsHandler // TasksGetTaskDetailsHandler sets the operation handler for the get task details operation TasksGetTaskDetailsHandler tasks.GetTaskDetailsHandler // TasksListTasksHandler sets the operation handler for the list tasks operation TasksListTasksHandler tasks.ListTasksHandler // TasksUpdateTaskHandler sets the operation handler for the update task operation TasksUpdateTaskHandler tasks.UpdateTaskHandler // TasksUploadTaskFileHandler sets the operation handler for the upload task file operation TasksUploadTaskFileHandler tasks.UploadTaskFileHandler // 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 }
TaskTrackerAPI This application implements a very simple issue tracker. It's implemented as an API which is described by this swagger spec document.
The go-swagger project uses this specification to test the code generation. This document contains all possible values for a swagger definition. This means that it exercises the framework relatively well.
func NewTaskTrackerAPI(spec *loads.Document) *TaskTrackerAPI
NewTaskTrackerAPI creates a new TaskTracker instance
func (o *TaskTrackerAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
AddMiddlewareFor adds a http middleware to existing handler
func (o *TaskTrackerAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (o *TaskTrackerAPI) 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 *TaskTrackerAPI) Context() *middleware.Context
Context returns the middleware context for the task tracker API
func (o *TaskTrackerAPI) DefaultConsumes() string
DefaultConsumes returns the default consumes media type
func (o *TaskTrackerAPI) DefaultProduces() string
DefaultProduces returns the default produces media type
func (o *TaskTrackerAPI) Formats() strfmt.Registry
Formats returns the registered string formats
HandlerFor gets a http.Handler for the provided operation method and path
func (o *TaskTrackerAPI) 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 *TaskTrackerAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (o *TaskTrackerAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
RegisterFormat registers a custom format validator
func (o *TaskTrackerAPI) RegisterProducer(mediaType string, producer runtime.Producer)
RegisterProducer allows you to add (or override) a producer for a media type.
func (o *TaskTrackerAPI) 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 *TaskTrackerAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (o *TaskTrackerAPI) SetDefaultConsumes(mediaType string)
SetDefaultConsumes returns the default consumes media type
func (o *TaskTrackerAPI) SetDefaultProduces(mediaType string)
SetDefaultProduces sets the default produces media type
func (o *TaskTrackerAPI) SetSpec(spec *loads.Document)
SetSpec sets a spec that will be served for the clients.
func (o *TaskTrackerAPI) UseRedoc()
UseRedoc for documentation at /docs
func (o *TaskTrackerAPI) UseSwaggerUI()
UseSwaggerUI for documentation at /docs
func (o *TaskTrackerAPI) Validate() error
Validate validates the registrations in the TaskTrackerAPI
Path | Synopsis |
---|---|
tasks |
Package operations imports 12 packages (graph) and is imported by 14 packages. Updated 2021-01-28. Refresh now. Tools for package owners.