operations

Documentation

Index

• type SimpleToDoListAPI
  • func NewSimpleToDoListAPI(spec *spec.Document) *SimpleToDoListAPI
  • func (o *SimpleToDoListAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]httpkit.Authenticator
  • func (o *SimpleToDoListAPI) ConsumersFor(mediaTypes []string) map[string]httpkit.Consumer
  • func (o *SimpleToDoListAPI) DefaultConsumes() string
  • func (o *SimpleToDoListAPI) DefaultProduces() string
  • func (o *SimpleToDoListAPI) Formats() strfmt.Registry
  • func (o *SimpleToDoListAPI) HandlerFor(method, path string) (http.Handler, bool)
  • func (o *SimpleToDoListAPI) ProducersFor(mediaTypes []string) map[string]httpkit.Producer
  • func (o *SimpleToDoListAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
  • func (o *SimpleToDoListAPI) Serve(builder middleware.Builder) http.Handler
  • func (o *SimpleToDoListAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
  • func (o *SimpleToDoListAPI) SetDefaultConsumes(mediaType string)
  • func (o *SimpleToDoListAPI) SetDefaultProduces(mediaType string)
  • func (o *SimpleToDoListAPI) Validate() error

Types

type SimpleToDoListAPI

type SimpleToDoListAPI struct {

	// JSONConsumer registers a consumer for a "application/io.swagger.examples.todo-list.v1+json" mime type
	JSONConsumer httpkit.Consumer

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

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

	// 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)
	// contains filtered or unexported fields
}

SimpleToDoListAPI the simple to do list API

func NewSimpleToDoListAPI

func NewSimpleToDoListAPI(spec *spec.Document) *SimpleToDoListAPI

NewSimpleToDoListAPI creates a new SimpleToDoList instance

func (*SimpleToDoListAPI) AuthenticatorsFor

func (o *SimpleToDoListAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]httpkit.Authenticator

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*SimpleToDoListAPI) ConsumersFor

func (o *SimpleToDoListAPI) ConsumersFor(mediaTypes []string) map[string]httpkit.Consumer

ConsumersFor gets the consumers for the specified media types

func (*SimpleToDoListAPI) DefaultConsumes

func (o *SimpleToDoListAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*SimpleToDoListAPI) DefaultProduces

func (o *SimpleToDoListAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*SimpleToDoListAPI) Formats

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

Formats returns the registered string formats

func (*SimpleToDoListAPI) HandlerFor

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

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

func (*SimpleToDoListAPI) ProducersFor

func (o *SimpleToDoListAPI) ProducersFor(mediaTypes []string) map[string]httpkit.Producer

ProducersFor gets the producers for the specified media types

func (*SimpleToDoListAPI) RegisterFormat

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

RegisterFormat registers a custom format validator

func (*SimpleToDoListAPI) Serve

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

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

ServeErrorFor gets a error handler for a given operation id

func (*SimpleToDoListAPI) SetDefaultConsumes

func (o *SimpleToDoListAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*SimpleToDoListAPI) SetDefaultProduces

func (o *SimpleToDoListAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*SimpleToDoListAPI) Validate

func (o *SimpleToDoListAPI) Validate() error

Validate validates the registrations in the SimpleToDoListAPI