Documentation
¶
Overview ¶
Package oapi_echo_server provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen version v1.12.4 DO NOT EDIT.
Index ¶
- func GetSwagger() (swagger *openapi3.T, err error)
- func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
- func RegisterHandlers(router EchoRouter, si ServerInterface)
- func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)
- type CreateUpdatePropertyInfoById200JSONResponse
- type CreateUpdatePropertyInfoById400JSONResponse
- type CreateUpdatePropertyInfoById404Response
- type CreateUpdatePropertyInfoById500JSONResponse
- type CreateUpdatePropertyInfoById501JSONResponse
- type CreateUpdatePropertyInfoByIdRequestObject
- type CreateUpdatePropertyInfoByIdResponseObject
- type CreateUpdatePropertyInfoByIddefaultResponse
- type EchoRouter
- type GetPropertiesInfo200JSONResponse
- type GetPropertiesInfo400JSONResponse
- type GetPropertiesInfo404Response
- type GetPropertiesInfo500JSONResponse
- type GetPropertiesInfo501JSONResponse
- type GetPropertiesInfoRequestObject
- type GetPropertiesInfoResponseObject
- type GetPropertiesInfodefaultResponse
- type GetPropertyInfoById200JSONResponse
- type GetPropertyInfoById400JSONResponse
- type GetPropertyInfoById404Response
- type GetPropertyInfoById500JSONResponse
- type GetPropertyInfoById501JSONResponse
- type GetPropertyInfoByIdRequestObject
- type GetPropertyInfoByIdResponseObject
- type GetPropertyInfoByIddefaultResponse
- type ServerInterface
- type ServerInterfaceWrapper
- type StrictHandlerFunc
- type StrictMiddlewareFunc
- type StrictServerInterface
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. 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 PathToRawSpec ¶
Constructs a synthetic filesystem for resolving external references when loading openapi specifications.
func RegisterHandlers ¶
func RegisterHandlers(router EchoRouter, si ServerInterface)
RegisterHandlers adds each server route to the EchoRouter.
func RegisterHandlersWithBaseURL ¶
func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)
Registers handlers, and prepends BaseURL to the paths, so that the paths can be served under a prefix.
Types ¶
type CreateUpdatePropertyInfoById200JSONResponse ¶
type CreateUpdatePropertyInfoById200JSONResponse PropertyInfoResponse
func (CreateUpdatePropertyInfoById200JSONResponse) VisitCreateUpdatePropertyInfoByIdResponse ¶
func (response CreateUpdatePropertyInfoById200JSONResponse) VisitCreateUpdatePropertyInfoByIdResponse(w http.ResponseWriter) error
type CreateUpdatePropertyInfoById400JSONResponse ¶
type CreateUpdatePropertyInfoById400JSONResponse GenericErrorResponse
func (CreateUpdatePropertyInfoById400JSONResponse) VisitCreateUpdatePropertyInfoByIdResponse ¶
func (response CreateUpdatePropertyInfoById400JSONResponse) VisitCreateUpdatePropertyInfoByIdResponse(w http.ResponseWriter) error
type CreateUpdatePropertyInfoById404Response ¶
type CreateUpdatePropertyInfoById404Response struct {
}
func (CreateUpdatePropertyInfoById404Response) VisitCreateUpdatePropertyInfoByIdResponse ¶
func (response CreateUpdatePropertyInfoById404Response) VisitCreateUpdatePropertyInfoByIdResponse(w http.ResponseWriter) error
type CreateUpdatePropertyInfoById500JSONResponse ¶
type CreateUpdatePropertyInfoById500JSONResponse GenericErrorResponse
func (CreateUpdatePropertyInfoById500JSONResponse) VisitCreateUpdatePropertyInfoByIdResponse ¶
func (response CreateUpdatePropertyInfoById500JSONResponse) VisitCreateUpdatePropertyInfoByIdResponse(w http.ResponseWriter) error
type CreateUpdatePropertyInfoById501JSONResponse ¶
type CreateUpdatePropertyInfoById501JSONResponse GenericErrorResponse
func (CreateUpdatePropertyInfoById501JSONResponse) VisitCreateUpdatePropertyInfoByIdResponse ¶
func (response CreateUpdatePropertyInfoById501JSONResponse) VisitCreateUpdatePropertyInfoByIdResponse(w http.ResponseWriter) error
type CreateUpdatePropertyInfoByIdRequestObject ¶
type CreateUpdatePropertyInfoByIdRequestObject struct {
PropertyId string `json:"propertyId"`
Body *CreateUpdatePropertyInfoByIdJSONRequestBody
}
type CreateUpdatePropertyInfoByIdResponseObject ¶
type CreateUpdatePropertyInfoByIdResponseObject interface {
VisitCreateUpdatePropertyInfoByIdResponse(w http.ResponseWriter) error
}
type CreateUpdatePropertyInfoByIddefaultResponse ¶
type CreateUpdatePropertyInfoByIddefaultResponse struct {
StatusCode int
}
func (CreateUpdatePropertyInfoByIddefaultResponse) VisitCreateUpdatePropertyInfoByIdResponse ¶
func (response CreateUpdatePropertyInfoByIddefaultResponse) VisitCreateUpdatePropertyInfoByIdResponse(w http.ResponseWriter) error
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 GetPropertiesInfo200JSONResponse ¶
type GetPropertiesInfo200JSONResponse PropertiesInfoResponse
func (GetPropertiesInfo200JSONResponse) VisitGetPropertiesInfoResponse ¶
func (response GetPropertiesInfo200JSONResponse) VisitGetPropertiesInfoResponse(w http.ResponseWriter) error
type GetPropertiesInfo400JSONResponse ¶
type GetPropertiesInfo400JSONResponse GenericErrorResponse
func (GetPropertiesInfo400JSONResponse) VisitGetPropertiesInfoResponse ¶
func (response GetPropertiesInfo400JSONResponse) VisitGetPropertiesInfoResponse(w http.ResponseWriter) error
type GetPropertiesInfo404Response ¶
type GetPropertiesInfo404Response struct {
}
func (GetPropertiesInfo404Response) VisitGetPropertiesInfoResponse ¶
func (response GetPropertiesInfo404Response) VisitGetPropertiesInfoResponse(w http.ResponseWriter) error
type GetPropertiesInfo500JSONResponse ¶
type GetPropertiesInfo500JSONResponse GenericErrorResponse
func (GetPropertiesInfo500JSONResponse) VisitGetPropertiesInfoResponse ¶
func (response GetPropertiesInfo500JSONResponse) VisitGetPropertiesInfoResponse(w http.ResponseWriter) error
type GetPropertiesInfo501JSONResponse ¶
type GetPropertiesInfo501JSONResponse GenericErrorResponse
func (GetPropertiesInfo501JSONResponse) VisitGetPropertiesInfoResponse ¶
func (response GetPropertiesInfo501JSONResponse) VisitGetPropertiesInfoResponse(w http.ResponseWriter) error
type GetPropertiesInfoRequestObject ¶
type GetPropertiesInfoRequestObject struct {
}
type GetPropertiesInfoResponseObject ¶
type GetPropertiesInfoResponseObject interface {
VisitGetPropertiesInfoResponse(w http.ResponseWriter) error
}
type GetPropertiesInfodefaultResponse ¶
type GetPropertiesInfodefaultResponse struct {
StatusCode int
}
func (GetPropertiesInfodefaultResponse) VisitGetPropertiesInfoResponse ¶
func (response GetPropertiesInfodefaultResponse) VisitGetPropertiesInfoResponse(w http.ResponseWriter) error
type GetPropertyInfoById200JSONResponse ¶
type GetPropertyInfoById200JSONResponse PropertyInfoResponse
func (GetPropertyInfoById200JSONResponse) VisitGetPropertyInfoByIdResponse ¶
func (response GetPropertyInfoById200JSONResponse) VisitGetPropertyInfoByIdResponse(w http.ResponseWriter) error
type GetPropertyInfoById400JSONResponse ¶
type GetPropertyInfoById400JSONResponse GenericErrorResponse
func (GetPropertyInfoById400JSONResponse) VisitGetPropertyInfoByIdResponse ¶
func (response GetPropertyInfoById400JSONResponse) VisitGetPropertyInfoByIdResponse(w http.ResponseWriter) error
type GetPropertyInfoById404Response ¶
type GetPropertyInfoById404Response struct {
}
func (GetPropertyInfoById404Response) VisitGetPropertyInfoByIdResponse ¶
func (response GetPropertyInfoById404Response) VisitGetPropertyInfoByIdResponse(w http.ResponseWriter) error
type GetPropertyInfoById500JSONResponse ¶
type GetPropertyInfoById500JSONResponse GenericErrorResponse
func (GetPropertyInfoById500JSONResponse) VisitGetPropertyInfoByIdResponse ¶
func (response GetPropertyInfoById500JSONResponse) VisitGetPropertyInfoByIdResponse(w http.ResponseWriter) error
type GetPropertyInfoById501JSONResponse ¶
type GetPropertyInfoById501JSONResponse GenericErrorResponse
func (GetPropertyInfoById501JSONResponse) VisitGetPropertyInfoByIdResponse ¶
func (response GetPropertyInfoById501JSONResponse) VisitGetPropertyInfoByIdResponse(w http.ResponseWriter) error
type GetPropertyInfoByIdRequestObject ¶
type GetPropertyInfoByIdRequestObject struct {
PropertyId string `json:"propertyId"`
}
type GetPropertyInfoByIdResponseObject ¶
type GetPropertyInfoByIdResponseObject interface {
VisitGetPropertyInfoByIdResponse(w http.ResponseWriter) error
}
type GetPropertyInfoByIddefaultResponse ¶
type GetPropertyInfoByIddefaultResponse struct {
StatusCode int
}
func (GetPropertyInfoByIddefaultResponse) VisitGetPropertyInfoByIdResponse ¶
func (response GetPropertyInfoByIddefaultResponse) VisitGetPropertyInfoByIdResponse(w http.ResponseWriter) error
type ServerInterface ¶
type ServerInterface interface {
// Retrieves properties information
// (GET /property)
GetPropertiesInfo(ctx echo.Context) error
// Retrieves property information by ID
// (GET /property/{propertyId})
GetPropertyInfoById(ctx echo.Context, propertyId string) error
// Set/Update property information by ID
// (POST /property/{propertyId})
CreateUpdatePropertyInfoById(ctx echo.Context, propertyId string) error
}
ServerInterface represents all server handlers.
func NewStrictHandler ¶
func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
}
ServerInterfaceWrapper converts echo contexts to parameters.
func (*ServerInterfaceWrapper) CreateUpdatePropertyInfoById ¶
func (w *ServerInterfaceWrapper) CreateUpdatePropertyInfoById(ctx echo.Context) error
CreateUpdatePropertyInfoById converts echo context to params.
func (*ServerInterfaceWrapper) GetPropertiesInfo ¶
func (w *ServerInterfaceWrapper) GetPropertiesInfo(ctx echo.Context) error
GetPropertiesInfo converts echo context to params.
func (*ServerInterfaceWrapper) GetPropertyInfoById ¶
func (w *ServerInterfaceWrapper) GetPropertyInfoById(ctx echo.Context) error
GetPropertyInfoById converts echo context to params.
type StrictHandlerFunc ¶
type StrictHandlerFunc func(ctx echo.Context, args interface{}) (interface{}, error)
type StrictMiddlewareFunc ¶
type StrictMiddlewareFunc func(f StrictHandlerFunc, operationID string) StrictHandlerFunc
type StrictServerInterface ¶
type StrictServerInterface interface {
// Retrieves properties information
// (GET /property)
GetPropertiesInfo(ctx context.Context, request GetPropertiesInfoRequestObject) (GetPropertiesInfoResponseObject, error)
// Retrieves property information by ID
// (GET /property/{propertyId})
GetPropertyInfoById(ctx context.Context, request GetPropertyInfoByIdRequestObject) (GetPropertyInfoByIdResponseObject, error)
// Set/Update property information by ID
// (POST /property/{propertyId})
CreateUpdatePropertyInfoById(ctx context.Context, request CreateUpdatePropertyInfoByIdRequestObject) (CreateUpdatePropertyInfoByIdResponseObject, error)
}
StrictServerInterface represents all server handlers.
Source Files
Click to show internal directories.
Click to hide internal directories.