api

package
v1.13.4 Latest Latest
Warning

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

 Go to latest Published: Aug 7, 2023 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Overview

Package api provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version (devel) DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetSwagger 

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func Handler 

func Handler(si ServerInterface) http.Handler

Handler creates http.Handler with routing matching OpenAPI spec.

func HandlerFromMux added in v1.3.4 

func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler

HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.

func HandlerFromMuxWithBaseURL added in v1.4.0 

func HandlerFromMuxWithBaseURL(si ServerInterface, r chi.Router, baseURL string) http.Handler

func HandlerWithOptions added in v1.4.2 

func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler

HandlerWithOptions creates http.Handler with additional options

func PathToRawSpec added in v1.6.1 

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

Types

type AddPetJSONRequestBody 

type AddPetJSONRequestBody = NewPet

AddPetJSONRequestBody defines body for AddPet for application/json ContentType.

type ChiServerOptions added in v1.4.2 

type ChiServerOptions struct {
	BaseURL          string
	BaseRouter       chi.Router
	Middlewares      []MiddlewareFunc
	ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type Error 

type Error struct {
	// Code Error code
	Code int32 `json:"code"`

	// Message Error message
	Message string `json:"message"`
}

Error defines model for Error.

type FindPetsParams 

type FindPetsParams struct {
	// Tags tags to filter by
	Tags *[]string `form:"tags,omitempty" json:"tags,omitempty"`

	// Limit maximum number of results to return
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
}

FindPetsParams defines parameters for FindPets.

type InvalidParamFormatError added in v1.9.0 

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

func (*InvalidParamFormatError) Error added in v1.9.0 

func (e *InvalidParamFormatError) Error() string

func (*InvalidParamFormatError) Unwrap added in v1.9.0 

func (e *InvalidParamFormatError) Unwrap() error

type MiddlewareFunc added in v1.4.2 

type MiddlewareFunc func(http.Handler) http.Handler

type NewPet 

type NewPet struct {
	// Name Name of the pet
	Name string `json:"name"`

	// Tag Type of the pet
	Tag *string `json:"tag,omitempty"`
}

NewPet defines model for NewPet.

type Pet 

type Pet struct {
	// Id Unique id of the pet
	Id int64 `json:"id"`

	// Name Name of the pet
	Name string `json:"name"`

	// Tag Type of the pet
	Tag *string `json:"tag,omitempty"`
}

Pet defines model for Pet.

type PetStore 

type PetStore struct {
	Pets   map[int64]Pet
	NextId int64
	Lock   sync.Mutex
}

func NewPetStore 

func NewPetStore() *PetStore

func (*PetStore) AddPet 

func (p *PetStore) AddPet(w http.ResponseWriter, r *http.Request)

func (*PetStore) DeletePet 

func (p *PetStore) DeletePet(w http.ResponseWriter, r *http.Request, id int64)

func (*PetStore) FindPetByID added in v1.7.1 

func (p *PetStore) FindPetByID(w http.ResponseWriter, r *http.Request, id int64)

func (*PetStore) FindPets 

func (p *PetStore) FindPets(w http.ResponseWriter, r *http.Request, params FindPetsParams)

FindPets implements all the handlers in the ServerInterface

type RequiredHeaderError added in v1.9.0 

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

func (*RequiredHeaderError) Error added in v1.9.0 

func (e *RequiredHeaderError) Error() string

func (*RequiredHeaderError) Unwrap added in v1.9.0 

func (e *RequiredHeaderError) Unwrap() error

type RequiredParamError added in v1.9.0 

type RequiredParamError struct {
	ParamName string
}

func (*RequiredParamError) Error added in v1.9.0 

func (e *RequiredParamError) Error() string

type ServerInterface 

type ServerInterface interface {
	// Returns all pets
	// (GET /pets)
	FindPets(w http.ResponseWriter, r *http.Request, params FindPetsParams)
	// Creates a new pet
	// (POST /pets)
	AddPet(w http.ResponseWriter, r *http.Request)
	// Deletes a pet by ID
	// (DELETE /pets/{id})
	DeletePet(w http.ResponseWriter, r *http.Request, id int64)
	// Returns a pet by ID
	// (GET /pets/{id})
	FindPetByID(w http.ResponseWriter, r *http.Request, id int64)
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper added in v1.3.10 

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandlerFunc   func(w http.ResponseWriter, r *http.Request, err error)
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) AddPet added in v1.3.10 

func (siw *ServerInterfaceWrapper) AddPet(w http.ResponseWriter, r *http.Request)

AddPet operation middleware

func (*ServerInterfaceWrapper) DeletePet added in v1.3.10 

func (siw *ServerInterfaceWrapper) DeletePet(w http.ResponseWriter, r *http.Request)

DeletePet operation middleware

func (*ServerInterfaceWrapper) FindPetByID added in v1.7.0 

func (siw *ServerInterfaceWrapper) FindPetByID(w http.ResponseWriter, r *http.Request)

FindPetByID operation middleware

func (*ServerInterfaceWrapper) FindPets added in v1.3.10 

func (siw *ServerInterfaceWrapper) FindPets(w http.ResponseWriter, r *http.Request)

FindPets operation middleware

type TooManyValuesForParamError added in v1.9.0 

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

func (*TooManyValuesForParamError) Error added in v1.9.0 

func (e *TooManyValuesForParamError) Error() string

type UnescapedCookieParamError added in v1.9.0 

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

func (*UnescapedCookieParamError) Error added in v1.9.0 

func (e *UnescapedCookieParamError) Error() string

func (*UnescapedCookieParamError) Unwrap added in v1.9.0 

func (e *UnescapedCookieParamError) Unwrap() error

type Unimplemented added in v1.13.1 

type Unimplemented struct{}

func (Unimplemented) AddPet added in v1.13.1 

func (_ Unimplemented) AddPet(w http.ResponseWriter, r *http.Request)

Creates a new pet (POST /pets)

func (Unimplemented) DeletePet added in v1.13.1 

func (_ Unimplemented) DeletePet(w http.ResponseWriter, r *http.Request, id int64)

Deletes a pet by ID (DELETE /pets/{id})

func (Unimplemented) FindPetByID added in v1.13.1 

func (_ Unimplemented) FindPetByID(w http.ResponseWriter, r *http.Request, id int64)

Returns a pet by ID (GET /pets/{id})

func (Unimplemented) FindPets added in v1.13.1 

func (_ Unimplemented) FindPets(w http.ResponseWriter, r *http.Request, params FindPetsParams)

Returns all pets (GET /pets)

type UnmarshalingParamError added in v1.9.0 

type UnmarshalingParamError struct {
	ParamName string
	Err       error
}

func (*UnmarshalingParamError) Error added in v1.9.0 

func (e *UnmarshalingParamError) Error() string

func (*UnmarshalingParamError) Unwrap added in v1.9.0 

func (e *UnmarshalingParamError) Unwrap() error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.