Help us shape the future of Go! Take the 2026 Go Developer Survey

operations

package
v0.18.0 Latest Latest
Warning

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

Go to latest
Published: Dec 22, 2018 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 added in v0.17.0

type TodoListAPI struct {
	Middleware func(middleware.Builder) http.Handler

	// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
	// It has a default implemention 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 implemention 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 implemention 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 a "application/io.swagger.examples.todo-list.v1+json" mime type
	JSONConsumer runtime.Consumer

	// JSONProducer registers a producer for a "application/io.swagger.examples.todo-list.v1+json" mime type
	JSONProducer runtime.Producer

	// KeyAuth registers a function that takes a token and returns a principal
	// it performs authentication based on an api key x-todolist-token provided in the header
	KeyAuth func(string) (interface{}, error)

	// APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal
	APIAuthorizer runtime.Authorizer

	// 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
	// TodosFindHandler sets the operation handler for the find operation
	TodosFindHandler todos.FindHandler
	// 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)

	// 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 todo list API

func NewTodoListAPI added in v0.17.0

func NewTodoListAPI(spec *loads.Document) *TodoListAPI

NewTodoListAPI creates a new TodoList instance

func (*TodoListAPI) AuthenticatorsFor added in v0.17.0

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 added in v0.17.0

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

Authorizer returns the registered authorizer

func (*TodoListAPI) ConsumersFor added in v0.17.0

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

ConsumersFor gets the consumers for the specified media types

func (*TodoListAPI) Context added in v0.17.0

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

Context returns the middleware context for the todo list API

func (*TodoListAPI) DefaultConsumes added in v0.17.0

func (o *TodoListAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*TodoListAPI) DefaultProduces added in v0.17.0

func (o *TodoListAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*TodoListAPI) Formats added in v0.17.0

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

Formats returns the registered string formats

func (*TodoListAPI) HandlerFor added in v0.17.0

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 added in v0.17.0

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 added in v0.17.0

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

ProducersFor gets the producers for the specified media types

func (*TodoListAPI) RegisterConsumer added in v0.17.0

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 added in v0.17.0

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

RegisterFormat registers a custom format validator

func (*TodoListAPI) RegisterProducer added in v0.17.0

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 added in v0.17.0

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 added in v0.17.0

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 added in v0.17.0

func (o *TodoListAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*TodoListAPI) SetDefaultProduces added in v0.17.0

func (o *TodoListAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*TodoListAPI) SetSpec added in v0.17.0

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

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

func (*TodoListAPI) Validate added in v0.17.0

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
y or Y : Canonical URL