restapi

Documentation

Overview

Package restapi Swagger Petstore This is a simplifed version of the sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.

Schemes:
  http
Host: petstore.org
BasePath: /api
Version: 1.0.0

Consumes:
- application/json

Produces:
- application/json

swagger:meta

Code generated by mockery v1.0.0

Code generated by mockery v1.0.0

Index

• Variables
• func Handler(c Config) (http.Handler, error)
• type Auth
• type Config
• type MockPetAPI
  • func (_m *MockPetAPI) PetCreate(ctx context.Context, params pet.PetCreateParams) middleware.Responder
  • func (_m *MockPetAPI) PetDelete(ctx context.Context, params pet.PetDeleteParams) middleware.Responder
  • func (_m *MockPetAPI) PetGet(ctx context.Context, params pet.PetGetParams) middleware.Responder
  • func (_m *MockPetAPI) PetList(ctx context.Context, params pet.PetListParams) middleware.Responder
  • func (_m *MockPetAPI) PetUpdate(ctx context.Context, params pet.PetUpdateParams) middleware.Responder
• type MockStoreAPI
  • func (_m *MockStoreAPI) InventoryGet(ctx context.Context, params store.InventoryGetParams) middleware.Responder
  • func (_m *MockStoreAPI) OrderCreate(ctx context.Context, params store.OrderCreateParams) middleware.Responder
  • func (_m *MockStoreAPI) OrderDelete(ctx context.Context, params store.OrderDeleteParams) middleware.Responder
  • func (_m *MockStoreAPI) OrderGet(ctx context.Context, params store.OrderGetParams) middleware.Responder
• type PetAPI
• type StoreAPI

Variables

var (
	OrderQueryParse    = query.MustNewBuilder(&query.Config{Model: models.Order{}}).ParseRequest
	PetQueryParse      = query.MustNewBuilder(&query.Config{Model: models.Pet{}}).ParseRequest
	CategoryQueryParse = query.MustNewBuilder(&query.Config{Model: models.Category{}}).ParseRequest
	TagQueryParse      = query.MustNewBuilder(&query.Config{Model: models.Tag{}}).ParseRequest
)

Query parse functions for all the models Those can be used to extract database query from the http path's query string

var SwaggerJSON json.RawMessage

SwaggerJSON embedded version of the swagger document used at generation time

Functions

func Handler

func Handler(c Config) (http.Handler, error)

Handler returns an http.Handler given the handler configuration It mounts all the business logic implementers in the right routing.

Types

type Auth

type Auth interface {
	APIKey(token string) (interface{}, error)
	Basic(user, password string) (interface{}, error)
	OAuth2(token string, scopes []string) (interface{}, error)
	// AuthStore is a function that stores authentication in the context object
	Store(context.Context, interface{}) context.Context
}

Auth functions

type Config

type Config struct {
	PetAPI
	StoreAPI
	Logger func(string, ...interface{})
	// InnerMiddleware is for the handler executors. These do not apply to the swagger.json document.
	// The middleware executes after routing but before authentication, binding and validation
	InnerMiddleware func(http.Handler) http.Handler
	Auth            Auth
}

Config is configuration for Handler

type MockPetAPI

type MockPetAPI struct {
	mock.Mock
}

MockPetAPI is an autogenerated mock type for the PetAPI type

func (*MockPetAPI) PetCreate

func (_m *MockPetAPI) PetCreate(ctx context.Context, params pet.PetCreateParams) middleware.Responder

PetCreate provides a mock function with given fields: ctx, params

func (*MockPetAPI) PetDelete

func (_m *MockPetAPI) PetDelete(ctx context.Context, params pet.PetDeleteParams) middleware.Responder

PetDelete provides a mock function with given fields: ctx, params

func (*MockPetAPI) PetGet

func (_m *MockPetAPI) PetGet(ctx context.Context, params pet.PetGetParams) middleware.Responder

PetGet provides a mock function with given fields: ctx, params

func (*MockPetAPI) PetList

func (_m *MockPetAPI) PetList(ctx context.Context, params pet.PetListParams) middleware.Responder

PetList provides a mock function with given fields: ctx, params

func (*MockPetAPI) PetUpdate

func (_m *MockPetAPI) PetUpdate(ctx context.Context, params pet.PetUpdateParams) middleware.Responder

PetUpdate provides a mock function with given fields: ctx, params

type MockStoreAPI

type MockStoreAPI struct {
	mock.Mock
}

MockStoreAPI is an autogenerated mock type for the StoreAPI type

func (*MockStoreAPI) InventoryGet

func (_m *MockStoreAPI) InventoryGet(ctx context.Context, params store.InventoryGetParams) middleware.Responder

InventoryGet provides a mock function with given fields: ctx, params

func (*MockStoreAPI) OrderCreate

func (_m *MockStoreAPI) OrderCreate(ctx context.Context, params store.OrderCreateParams) middleware.Responder

OrderCreate provides a mock function with given fields: ctx, params

func (*MockStoreAPI) OrderDelete

func (_m *MockStoreAPI) OrderDelete(ctx context.Context, params store.OrderDeleteParams) middleware.Responder

OrderDelete provides a mock function with given fields: ctx, params

func (*MockStoreAPI) OrderGet

func (_m *MockStoreAPI) OrderGet(ctx context.Context, params store.OrderGetParams) middleware.Responder

OrderGet provides a mock function with given fields: ctx, params

type PetAPI

type PetAPI interface {
	PetCreate(ctx context.Context, params pet.PetCreateParams) middleware.Responder
	PetDelete(ctx context.Context, params pet.PetDeleteParams) middleware.Responder
	PetGet(ctx context.Context, params pet.PetGetParams) middleware.Responder
	PetList(ctx context.Context, params pet.PetListParams) middleware.Responder
	PetUpdate(ctx context.Context, params pet.PetUpdateParams) middleware.Responder
}

PetAPI

type StoreAPI

type StoreAPI interface {
	InventoryGet(ctx context.Context, params store.InventoryGetParams) middleware.Responder
	OrderCreate(ctx context.Context, params store.OrderCreateParams) middleware.Responder
	// OrderDelete is For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors
	OrderDelete(ctx context.Context, params store.OrderDeleteParams) middleware.Responder
	// OrderGet is For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions
	OrderGet(ctx context.Context, params store.OrderGetParams) middleware.Responder
}

StoreAPI