operations

package
Version: v0.26.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 12, 2021 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type TodoListAPI

type TodoListAPI 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.goswagger.examples.todo-list.v1+json
	JSONConsumer runtime.Consumer

	// JSONProducer registers a producer for the following mime types:
	//   - application/io.goswagger.examples.todo-list.v1+json
	JSONProducer runtime.Producer

	// 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
	// TodosFindTodosHandler sets the operation handler for the find todos operation
	TodosFindTodosHandler todos.FindTodosHandler
	// 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, ...interface{})
	// contains filtered or unexported fields
}

TodoListAPI The product of a tutorial on goswagger.io

func NewTodoListAPI

func NewTodoListAPI(spec *loads.Document) *TodoListAPI

NewTodoListAPI creates a new TodoList instance

func (*TodoListAPI) AddMiddlewareFor added in v0.26.0

func (o *TodoListAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)

AddMiddlewareFor adds a http middleware to existing handler

func (*TodoListAPI) AuthenticatorsFor

func (o *TodoListAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*TodoListAPI) Authorizer

func (o *TodoListAPI) Authorizer() runtime.Authorizer

Authorizer returns the registered authorizer

func (*TodoListAPI) ConsumersFor

func (o *TodoListAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer

ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.

func (*TodoListAPI) Context

func (o *TodoListAPI) Context() *middleware.Context

Context returns the middleware context for the todo list API

func (*TodoListAPI) DefaultConsumes

func (o *TodoListAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*TodoListAPI) DefaultProduces

func (o *TodoListAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*TodoListAPI) Formats

func (o *TodoListAPI) Formats() strfmt.Registry

Formats returns the registered string formats

func (*TodoListAPI) HandlerFor

func (o *TodoListAPI) HandlerFor(method, path string) (http.Handler, bool)

HandlerFor gets a http.Handler for the provided operation method and path

func (*TodoListAPI) Init

func (o *TodoListAPI) Init()

Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit

func (*TodoListAPI) ProducersFor

func (o *TodoListAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer

ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.

func (*TodoListAPI) RegisterConsumer

func (o *TodoListAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)

RegisterConsumer allows you to add (or override) a consumer for a media type.

func (*TodoListAPI) RegisterFormat

func (o *TodoListAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)

RegisterFormat registers a custom format validator

func (*TodoListAPI) RegisterProducer

func (o *TodoListAPI) RegisterProducer(mediaType string, producer runtime.Producer)

RegisterProducer allows you to add (or override) a producer for a media type.

func (*TodoListAPI) Serve

func (o *TodoListAPI) 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 (*TodoListAPI) ServeErrorFor

func (o *TodoListAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)

ServeErrorFor gets a error handler for a given operation id

func (*TodoListAPI) SetDefaultConsumes

func (o *TodoListAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*TodoListAPI) SetDefaultProduces

func (o *TodoListAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*TodoListAPI) SetSpec

func (o *TodoListAPI) SetSpec(spec *loads.Document)

SetSpec sets a spec that will be served for the clients.

func (*TodoListAPI) UseRedoc added in v0.26.0

func (o *TodoListAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*TodoListAPI) UseSwaggerUI added in v0.26.0

func (o *TodoListAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*TodoListAPI) Validate

func (o *TodoListAPI) Validate() error

Validate validates the registrations in the TodoListAPI

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL