Documentation
¶
Overview ¶
Package api provides primitives to interact the openapi HTTP API.
Code generated by github.com/indigonote/oapi-codegen DO NOT EDIT.
Package api provides primitives to interact the openapi HTTP API.
Code generated by github.com/indigonote/oapi-codegen DO NOT EDIT.
Index ¶
- func GetSwagger() (*openapi3.Swagger, error)
- func Regexp(fl validator.FieldLevel) bool
- func RegisterHandlers(router EchoRouter, si ServerInterface)
- type AddPetJSONBody
- type AddPetJSONRequestBody
- type EchoRouter
- type Error
- type FindPetsParams
- type NewPet
- type Pet
- type PetStore
- type ServerInterface
- type ServerInterfaceWrapper
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetSwagger ¶
GetSwagger returns the Swagger specification corresponding to the generated code in this file.
func Regexp ¶
func Regexp(fl validator.FieldLevel) bool
func RegisterHandlers ¶
func RegisterHandlers(router EchoRouter, si ServerInterface)
RegisterHandlers adds each server route to the EchoRouter.
Types ¶
type AddPetJSONRequestBody ¶
type AddPetJSONRequestBody AddPetJSONBody
AddPetRequestBody defines body for AddPet for application/json ContentType.
type EchoRouter ¶
type EchoRouter interface {
CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
}
This is a simple interface which specifies echo.Route addition functions which are present on both echo.Echo and echo.Group, since we want to allow using either of them for path registration
type Error ¶
type Error struct {
// Error code
Code int32 `json:"code"`
// Error message
Message string `json:"message"`
}
Error defines model for Error.
type FindPetsParams ¶
type FindPetsParams struct {
// tags to filter by
Tags *[]string `json:"tags,omitempty"`
// maximum number of results to return
Limit *int32 `json:"limit,omitempty"`
}
FindPetsParams defines parameters for FindPets.
type NewPet ¶
type NewPet struct {
// Name of the pet
Name *string `json:"name" validate:"omitempty,alphanum,max=1048576"`
Size int `json:"size" validate:"min=0,max=20"`
// Type of the pet
Tag *string `json:"tag,omitempty" validate:"omitempty,min=2,max=32,regex=^[A-Za-z]+"`
}
NewPet defines model for NewPet.
type Pet ¶
type Pet struct {
// Embedded struct due to allOf(#/components/schemas/NewPet)
NewPet
// Unique id of the pet
Id int64 `json:"id" validate:"max=100,min=1"`
}
Pet defines model for Pet.
type PetStore ¶
func NewPetStore ¶
func NewPetStore() *PetStore
type ServerInterface ¶
type ServerInterface interface {
// Returns all pets
// (GET /pets)
FindPets(ctx echo.Context, params FindPetsParams) error
// Creates a new pet
// (POST /pets)
AddPet(ctx echo.Context) error
// Deletes a pet by ID
// (DELETE /pets/{id})
DeletePet(ctx echo.Context, id int64) error
// Returns a pet by ID
// (GET /pets/{id})
FindPetById(ctx echo.Context, id int64) error
}
ServerInterface represents all server handlers.
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
}
ServerInterfaceWrapper converts echo contexts to parameters.
func (*ServerInterfaceWrapper) AddPet ¶
func (w *ServerInterfaceWrapper) AddPet(ctx echo.Context) error
AddPet converts echo context to params.
func (*ServerInterfaceWrapper) DeletePet ¶
func (w *ServerInterfaceWrapper) DeletePet(ctx echo.Context) error
DeletePet converts echo context to params.
func (*ServerInterfaceWrapper) FindPetById ¶
func (w *ServerInterfaceWrapper) FindPetById(ctx echo.Context) error
FindPetById converts echo context to params.
Source Files