go-swagger: github.com/go-swagger/go-swagger/examples/generated/restapi/operations Index | Files | Directories

package operations

import "github.com/go-swagger/go-swagger/examples/generated/restapi/operations"

Index

Package Files

petstore_api.go

type PetstoreAPI Uses

type PetstoreAPI 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 a "application/json" mime type
    JSONConsumer runtime.Consumer
    // UrlformConsumer registers a consumer for a "application/x-www-form-urlencoded" mime type
    UrlformConsumer runtime.Consumer
    // XMLConsumer registers a consumer for a "application/xml" mime type
    XMLConsumer runtime.Consumer

    // JSONProducer registers a producer for a "application/json" mime type
    JSONProducer runtime.Producer
    // XMLProducer registers a producer for a "application/xml" mime type
    XMLProducer runtime.Producer

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

    // PetstoreAuthAuth registers a function that takes an access token and a collection of required scopes and returns a principal
    // it performs authentication based on an oauth2 bearer token provided in the request
    PetstoreAuthAuth func(string, []string) (interface{}, error)

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

    // PetAddPetHandler sets the operation handler for the add pet operation
    PetAddPetHandler pet.AddPetHandler
    // UserCreateUserHandler sets the operation handler for the create user operation
    UserCreateUserHandler user.CreateUserHandler
    // UserCreateUsersWithArrayInputHandler sets the operation handler for the create users with array input operation
    UserCreateUsersWithArrayInputHandler user.CreateUsersWithArrayInputHandler
    // UserCreateUsersWithListInputHandler sets the operation handler for the create users with list input operation
    UserCreateUsersWithListInputHandler user.CreateUsersWithListInputHandler
    // StoreDeleteOrderHandler sets the operation handler for the delete order operation
    StoreDeleteOrderHandler store.DeleteOrderHandler
    // PetDeletePetHandler sets the operation handler for the delete pet operation
    PetDeletePetHandler pet.DeletePetHandler
    // UserDeleteUserHandler sets the operation handler for the delete user operation
    UserDeleteUserHandler user.DeleteUserHandler
    // PetFindPetsByStatusHandler sets the operation handler for the find pets by status operation
    PetFindPetsByStatusHandler pet.FindPetsByStatusHandler
    // PetFindPetsByTagsHandler sets the operation handler for the find pets by tags operation
    PetFindPetsByTagsHandler pet.FindPetsByTagsHandler
    // StoreGetOrderByIDHandler sets the operation handler for the get order by Id operation
    StoreGetOrderByIDHandler store.GetOrderByIDHandler
    // PetGetPetByIDHandler sets the operation handler for the get pet by Id operation
    PetGetPetByIDHandler pet.GetPetByIDHandler
    // UserGetUserByNameHandler sets the operation handler for the get user by name operation
    UserGetUserByNameHandler user.GetUserByNameHandler
    // UserLoginUserHandler sets the operation handler for the login user operation
    UserLoginUserHandler user.LoginUserHandler
    // UserLogoutUserHandler sets the operation handler for the logout user operation
    UserLogoutUserHandler user.LogoutUserHandler
    // StorePlaceOrderHandler sets the operation handler for the place order operation
    StorePlaceOrderHandler store.PlaceOrderHandler
    // PetUpdatePetHandler sets the operation handler for the update pet operation
    PetUpdatePetHandler pet.UpdatePetHandler
    // PetUpdatePetWithFormHandler sets the operation handler for the update pet with form operation
    PetUpdatePetWithFormHandler pet.UpdatePetWithFormHandler
    // UserUpdateUserHandler sets the operation handler for the update user operation
    UserUpdateUserHandler user.UpdateUserHandler

    // 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
}

PetstoreAPI This is a sample server Petstore server.

[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel '#swagger' on irc.freenode.net.

For this sample, you can use the api key 'special-key' to test the authorization filters

func NewPetstoreAPI Uses

func NewPetstoreAPI(spec *loads.Document) *PetstoreAPI

NewPetstoreAPI creates a new Petstore instance

func (*PetstoreAPI) AuthenticatorsFor Uses

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*PetstoreAPI) Authorizer Uses

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

Authorizer returns the registered authorizer

func (*PetstoreAPI) ConsumersFor Uses

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

ConsumersFor gets the consumers for the specified media types

func (*PetstoreAPI) Context Uses

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

Context returns the middleware context for the petstore API

func (*PetstoreAPI) DefaultConsumes Uses

func (o *PetstoreAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*PetstoreAPI) DefaultProduces Uses

func (o *PetstoreAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*PetstoreAPI) Formats Uses

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

Formats returns the registered string formats

func (*PetstoreAPI) HandlerFor Uses

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

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

func (*PetstoreAPI) Init Uses

func (o *PetstoreAPI) Init()

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

func (*PetstoreAPI) ProducersFor Uses

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

ProducersFor gets the producers for the specified media types

func (*PetstoreAPI) RegisterConsumer Uses

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

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

func (*PetstoreAPI) RegisterFormat Uses

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

RegisterFormat registers a custom format validator

func (*PetstoreAPI) RegisterProducer Uses

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

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

func (*PetstoreAPI) Serve Uses

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

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

ServeErrorFor gets a error handler for a given operation id

func (*PetstoreAPI) SetDefaultConsumes Uses

func (o *PetstoreAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*PetstoreAPI) SetDefaultProduces Uses

func (o *PetstoreAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*PetstoreAPI) SetSpec Uses

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

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

func (*PetstoreAPI) Validate Uses

func (o *PetstoreAPI) Validate() error

Validate validates the registrations in the PetstoreAPI

Directories

PathSynopsis
pet
store
user

Package operations imports 14 packages (graph) and is imported by 5 packages. Updated 2019-08-21. Refresh now. Tools for package owners.