Documentation
¶
Index ¶
- type TaskTrackerAPI
- func (o *TaskTrackerAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *TaskTrackerAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *TaskTrackerAPI) DefaultConsumes() string
- func (o *TaskTrackerAPI) DefaultProduces() string
- func (o *TaskTrackerAPI) Formats() strfmt.Registry
- func (o *TaskTrackerAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *TaskTrackerAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *TaskTrackerAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *TaskTrackerAPI) Serve(builder middleware.Builder) http.Handler
- func (o *TaskTrackerAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *TaskTrackerAPI) SetDefaultConsumes(mediaType string)
- func (o *TaskTrackerAPI) SetDefaultProduces(mediaType string)
- func (o *TaskTrackerAPI) SetSpec(spec *loads.Document)
- func (o *TaskTrackerAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type TaskTrackerAPI ¶
type TaskTrackerAPI struct {
// JSONConsumer registers a consumer for a "application/vnd.goswagger.examples.task-tracker.v1+json" mime type
JSONConsumer runtime.Consumer
// MultipartformConsumer registers a consumer for a "multipart/form-data" mime type
MultipartformConsumer runtime.Consumer
// JSONProducer registers a producer for a "application/vnd.goswagger.examples.task-tracker.v1+json" mime type
JSONProducer runtime.Producer
// 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)
// 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)
// 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)
// 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 ¶
func NewTaskTrackerAPI(spec *loads.Document) *TaskTrackerAPI
NewTaskTrackerAPI creates a new TaskTracker instance
func (*TaskTrackerAPI) AuthenticatorsFor ¶
func (o *TaskTrackerAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*TaskTrackerAPI) ConsumersFor ¶
func (o *TaskTrackerAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
ConsumersFor gets the consumers for the specified media types
func (*TaskTrackerAPI) DefaultConsumes ¶
func (o *TaskTrackerAPI) DefaultConsumes() string
DefaultConsumes returns the default consumes media type
func (*TaskTrackerAPI) DefaultProduces ¶
func (o *TaskTrackerAPI) DefaultProduces() string
DefaultProduces returns the default produces media type
func (*TaskTrackerAPI) Formats ¶
func (o *TaskTrackerAPI) Formats() strfmt.Registry
Formats returns the registered string formats
func (*TaskTrackerAPI) HandlerFor ¶
func (o *TaskTrackerAPI) HandlerFor(method, path string) (http.Handler, bool)
HandlerFor gets a http.Handler for the provided operation method and path
func (*TaskTrackerAPI) ProducersFor ¶
func (o *TaskTrackerAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
ProducersFor gets the producers for the specified media types
func (*TaskTrackerAPI) RegisterFormat ¶
func (o *TaskTrackerAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
RegisterFormat registers a custom format validator
func (*TaskTrackerAPI) Serve ¶
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 (*TaskTrackerAPI) ServeErrorFor ¶
func (o *TaskTrackerAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*TaskTrackerAPI) SetDefaultConsumes ¶
func (o *TaskTrackerAPI) SetDefaultConsumes(mediaType string)
SetDefaultConsumes returns the default consumes media type
func (*TaskTrackerAPI) SetDefaultProduces ¶
func (o *TaskTrackerAPI) SetDefaultProduces(mediaType string)
SetDefaultProduces sets the default produces media type
func (*TaskTrackerAPI) SetSpec ¶
func (o *TaskTrackerAPI) SetSpec(spec *loads.Document)
SetSpec sets a spec that will be served for the clients.
func (*TaskTrackerAPI) Validate ¶
func (o *TaskTrackerAPI) Validate() error
Validate validates the registrations in the TaskTrackerAPI