api

package

Go to main page

Versions in this module

v1

deprecated

v1.13.4

Aug 7, 2023

v1.13.3

Aug 3, 2023

Changes in this version

+ type UnionExample200ApplicationAlternativePlusJSONResponse struct

+ Body Example

+ Headers UnionExample200ResponseHeaders

+ func (response UnionExample200ApplicationAlternativePlusJSONResponse) VisitUnionExampleResponse(w http.ResponseWriter) error

v1.13.2

Jul 31, 2023

v1.13.1

Jul 31, 2023

Changes in this version

type ServerInterface

+ UnionExample func(ctx echo.Context) error

type ServerInterfaceWrapper

+ func (w *ServerInterfaceWrapper) UnionExample(ctx echo.Context) error

type StrictServer

+ func (s StrictServer) UnionExample(ctx context.Context, request UnionExampleRequestObject) (UnionExampleResponseObject, error)

type StrictServerInterface

+ UnionExample func(ctx context.Context, request UnionExampleRequestObject) (UnionExampleResponseObject, error)

+ type UnionExample200JSONResponse struct

+ Body struct{}

+ Headers UnionExample200ResponseHeaders

+ func (response UnionExample200JSONResponse) VisitUnionExampleResponse(w http.ResponseWriter) error

+ type UnionExample200ResponseHeaders struct

+ Header1 string

+ Header2 int

+ type UnionExample400Response = BadrequestResponse

+ func (response UnionExample400Response) VisitUnionExampleResponse(w http.ResponseWriter) error

+ type UnionExampleJSONRequestBody = Example

+ type UnionExampleRequestObject struct

+ Body *UnionExampleJSONRequestBody

+ type UnionExampleResponseObject interface

+ VisitUnionExampleResponse func(w http.ResponseWriter) error

+ type UnionExampledefaultResponse struct

+ StatusCode int

+ func (response UnionExampledefaultResponse) VisitUnionExampleResponse(w http.ResponseWriter) error

v1.13.0

Jun 2, 2023

Changes in this version

+ type ReservedGoKeywordParameters200TextResponse string

+ func (response ReservedGoKeywordParameters200TextResponse) VisitReservedGoKeywordParametersResponse(w http.ResponseWriter) error

+ type ReservedGoKeywordParametersRequestObject struct

+ Type string

+ type ReservedGoKeywordParametersResponseObject interface

+ VisitReservedGoKeywordParametersResponse func(w http.ResponseWriter) error

type ServerInterface

+ ReservedGoKeywordParameters func(ctx echo.Context, pType string) error

type ServerInterfaceWrapper

+ func (w *ServerInterfaceWrapper) ReservedGoKeywordParameters(ctx echo.Context) error

type StrictServer

+ func (s StrictServer) ReservedGoKeywordParameters(ctx context.Context, request ReservedGoKeywordParametersRequestObject) (ReservedGoKeywordParametersResponseObject, error)

type StrictServerInterface

+ ReservedGoKeywordParameters func(ctx context.Context, request ReservedGoKeywordParametersRequestObject) (ReservedGoKeywordParametersResponseObject, error)

v1.12.4

Dec 1, 2022

v1.12.3

Nov 21, 2022

v1.12.2

Oct 29, 2022

v1.12.1

Oct 28, 2022

v1.12.0

Oct 27, 2022

Changes in this version

+ 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 BadrequestResponse struct

+ type EchoRouter interface

+ CONNECT func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ DELETE func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ GET func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ HEAD func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ OPTIONS func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ PATCH func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ POST func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ PUT func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ TRACE func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ type Example struct

+ Value *string

+ type HeadersExample200JSONResponse struct

+ Body Example

+ Headers HeadersExample200ResponseHeaders

+ func (response HeadersExample200JSONResponse) VisitHeadersExampleResponse(w http.ResponseWriter) error

+ type HeadersExample200ResponseHeaders struct

+ Header1 string

+ Header2 int

+ type HeadersExample400Response = BadrequestResponse

+ func (response HeadersExample400Response) VisitHeadersExampleResponse(w http.ResponseWriter) error

+ type HeadersExampleJSONRequestBody = Example

+ type HeadersExampleParams struct

+ Header1 string

+ Header2 *int

+ type HeadersExampleRequestObject struct

+ Body *HeadersExampleJSONRequestBody

+ Params HeadersExampleParams

+ type HeadersExampleResponseObject interface

+ VisitHeadersExampleResponse func(w http.ResponseWriter) error

+ type HeadersExampledefaultResponse struct

+ StatusCode int

+ func (response HeadersExampledefaultResponse) VisitHeadersExampleResponse(w http.ResponseWriter) error

+ type JSONExample200JSONResponse Example

+ func (response JSONExample200JSONResponse) VisitJSONExampleResponse(w http.ResponseWriter) error

+ type JSONExample400Response = BadrequestResponse

+ func (response JSONExample400Response) VisitJSONExampleResponse(w http.ResponseWriter) error

+ type JSONExampleJSONRequestBody = Example

+ type JSONExampleRequestObject struct

+ Body *JSONExampleJSONRequestBody

+ type JSONExampleResponseObject interface

+ VisitJSONExampleResponse func(w http.ResponseWriter) error

+ type JSONExampledefaultResponse struct

+ StatusCode int

+ func (response JSONExampledefaultResponse) VisitJSONExampleResponse(w http.ResponseWriter) error

+ type MultipartExample200MultipartResponse func(writer *multipart.Writer) error

+ func (response MultipartExample200MultipartResponse) VisitMultipartExampleResponse(w http.ResponseWriter) error

+ type MultipartExample400Response = BadrequestResponse

+ func (response MultipartExample400Response) VisitMultipartExampleResponse(w http.ResponseWriter) error

+ type MultipartExampleMultipartRequestBody = Example

+ type MultipartExampleRequestObject struct

+ Body *multipart.Reader

+ type MultipartExampleResponseObject interface

+ VisitMultipartExampleResponse func(w http.ResponseWriter) error

+ type MultipartExampledefaultResponse struct

+ StatusCode int

+ func (response MultipartExampledefaultResponse) VisitMultipartExampleResponse(w http.ResponseWriter) error

+ type MultipleRequestAndResponseTypes200FormdataResponse Example

+ func (response MultipleRequestAndResponseTypes200FormdataResponse) VisitMultipleRequestAndResponseTypesResponse(w http.ResponseWriter) error

+ type MultipleRequestAndResponseTypes200ImagepngResponse struct

+ Body io.Reader

+ ContentLength int64

+ func (response MultipleRequestAndResponseTypes200ImagepngResponse) VisitMultipleRequestAndResponseTypesResponse(w http.ResponseWriter) error

+ type MultipleRequestAndResponseTypes200JSONResponse Example

+ func (response MultipleRequestAndResponseTypes200JSONResponse) VisitMultipleRequestAndResponseTypesResponse(w http.ResponseWriter) error

+ type MultipleRequestAndResponseTypes200MultipartResponse func(writer *multipart.Writer) error

+ func (response MultipleRequestAndResponseTypes200MultipartResponse) VisitMultipleRequestAndResponseTypesResponse(w http.ResponseWriter) error

+ type MultipleRequestAndResponseTypes200TextResponse string

+ func (response MultipleRequestAndResponseTypes200TextResponse) VisitMultipleRequestAndResponseTypesResponse(w http.ResponseWriter) error

+ type MultipleRequestAndResponseTypes400Response = BadrequestResponse

+ func (response MultipleRequestAndResponseTypes400Response) VisitMultipleRequestAndResponseTypesResponse(w http.ResponseWriter) error

+ type MultipleRequestAndResponseTypesFormdataRequestBody = Example

+ type MultipleRequestAndResponseTypesJSONRequestBody = Example

+ type MultipleRequestAndResponseTypesMultipartRequestBody = Example

+ type MultipleRequestAndResponseTypesRequestObject struct

+ Body io.Reader

+ FormdataBody *MultipleRequestAndResponseTypesFormdataRequestBody

+ JSONBody *MultipleRequestAndResponseTypesJSONRequestBody

+ MultipartBody *multipart.Reader

+ TextBody *MultipleRequestAndResponseTypesTextRequestBody

+ type MultipleRequestAndResponseTypesResponseObject interface

+ VisitMultipleRequestAndResponseTypesResponse func(w http.ResponseWriter) error

+ type MultipleRequestAndResponseTypesTextBody = string

+ type MultipleRequestAndResponseTypesTextRequestBody = MultipleRequestAndResponseTypesTextBody

+ type ReusableResponses200JSONResponse struct

+ func (response ReusableResponses200JSONResponse) VisitReusableResponsesResponse(w http.ResponseWriter) error

+ type ReusableResponses400Response = BadrequestResponse

+ func (response ReusableResponses400Response) VisitReusableResponsesResponse(w http.ResponseWriter) error

+ type ReusableResponsesJSONRequestBody = Example

+ type ReusableResponsesRequestObject struct

+ Body *ReusableResponsesJSONRequestBody

+ type ReusableResponsesResponseObject interface

+ VisitReusableResponsesResponse func(w http.ResponseWriter) error

+ type ReusableResponsesdefaultResponse struct

+ StatusCode int

+ func (response ReusableResponsesdefaultResponse) VisitReusableResponsesResponse(w http.ResponseWriter) error

+ type Reusableresponse = Example

+ type ReusableresponseJSONResponse struct

+ Body Example

+ Headers ReusableresponseResponseHeaders

+ type ReusableresponseResponseHeaders struct

+ Header1 string

+ Header2 int

+ type ServerInterface interface

+ HeadersExample func(ctx echo.Context, params HeadersExampleParams) error

+ JSONExample func(ctx echo.Context) error

+ MultipartExample func(ctx echo.Context) error

+ MultipleRequestAndResponseTypes func(ctx echo.Context) error

+ ReusableResponses func(ctx echo.Context) error

+ TextExample func(ctx echo.Context) error

+ URLEncodedExample func(ctx echo.Context) error

+ UnknownExample func(ctx echo.Context) error

+ UnspecifiedContentType func(ctx echo.Context) error

+ func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface

+ type ServerInterfaceWrapper struct

+ Handler ServerInterface

+ func (w *ServerInterfaceWrapper) HeadersExample(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) JSONExample(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) MultipartExample(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) MultipleRequestAndResponseTypes(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) ReusableResponses(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) TextExample(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) URLEncodedExample(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) UnknownExample(ctx echo.Context) error

+ func (w *ServerInterfaceWrapper) UnspecifiedContentType(ctx echo.Context) error

+ type StrictHandlerFunc func(ctx echo.Context, args interface{}) (interface{}, error)

+ type StrictMiddlewareFunc func(f StrictHandlerFunc, operationID string) StrictHandlerFunc

+ type StrictServer struct

+ func (s StrictServer) HeadersExample(ctx context.Context, request HeadersExampleRequestObject) (HeadersExampleResponseObject, error)

+ func (s StrictServer) JSONExample(ctx context.Context, request JSONExampleRequestObject) (JSONExampleResponseObject, error)

+ func (s StrictServer) MultipartExample(ctx context.Context, request MultipartExampleRequestObject) (MultipartExampleResponseObject, error)

+ func (s StrictServer) MultipleRequestAndResponseTypes(ctx context.Context, request MultipleRequestAndResponseTypesRequestObject) (MultipleRequestAndResponseTypesResponseObject, error)

+ func (s StrictServer) ReusableResponses(ctx context.Context, request ReusableResponsesRequestObject) (ReusableResponsesResponseObject, error)

+ func (s StrictServer) TextExample(ctx context.Context, request TextExampleRequestObject) (TextExampleResponseObject, error)

+ func (s StrictServer) URLEncodedExample(ctx context.Context, request URLEncodedExampleRequestObject) (URLEncodedExampleResponseObject, error)

+ func (s StrictServer) UnknownExample(ctx context.Context, request UnknownExampleRequestObject) (UnknownExampleResponseObject, error)

+ func (s StrictServer) UnspecifiedContentType(ctx context.Context, request UnspecifiedContentTypeRequestObject) (UnspecifiedContentTypeResponseObject, error)

+ type StrictServerInterface interface

+ HeadersExample func(ctx context.Context, request HeadersExampleRequestObject) (HeadersExampleResponseObject, error)

+ JSONExample func(ctx context.Context, request JSONExampleRequestObject) (JSONExampleResponseObject, error)

+ MultipartExample func(ctx context.Context, request MultipartExampleRequestObject) (MultipartExampleResponseObject, error)

+ MultipleRequestAndResponseTypes func(ctx context.Context, request MultipleRequestAndResponseTypesRequestObject) (MultipleRequestAndResponseTypesResponseObject, error)

+ ReusableResponses func(ctx context.Context, request ReusableResponsesRequestObject) (ReusableResponsesResponseObject, error)

+ TextExample func(ctx context.Context, request TextExampleRequestObject) (TextExampleResponseObject, error)

+ URLEncodedExample func(ctx context.Context, request URLEncodedExampleRequestObject) (URLEncodedExampleResponseObject, error)

+ UnknownExample func(ctx context.Context, request UnknownExampleRequestObject) (UnknownExampleResponseObject, error)

+ UnspecifiedContentType func(ctx context.Context, request UnspecifiedContentTypeRequestObject) (UnspecifiedContentTypeResponseObject, error)

+ type TextExample200TextResponse string

+ func (response TextExample200TextResponse) VisitTextExampleResponse(w http.ResponseWriter) error

+ type TextExample400Response = BadrequestResponse

+ func (response TextExample400Response) VisitTextExampleResponse(w http.ResponseWriter) error

+ type TextExampleRequestObject struct

+ Body *TextExampleTextRequestBody

+ type TextExampleResponseObject interface

+ VisitTextExampleResponse func(w http.ResponseWriter) error

+ type TextExampleTextBody = string

+ type TextExampleTextRequestBody = TextExampleTextBody

+ type TextExampledefaultResponse struct

+ StatusCode int

+ func (response TextExampledefaultResponse) VisitTextExampleResponse(w http.ResponseWriter) error

+ type URLEncodedExample200FormdataResponse Example

+ func (response URLEncodedExample200FormdataResponse) VisitURLEncodedExampleResponse(w http.ResponseWriter) error

+ type URLEncodedExample400Response = BadrequestResponse

+ func (response URLEncodedExample400Response) VisitURLEncodedExampleResponse(w http.ResponseWriter) error

+ type URLEncodedExampleFormdataRequestBody = Example

+ type URLEncodedExampleRequestObject struct

+ Body *URLEncodedExampleFormdataRequestBody

+ type URLEncodedExampleResponseObject interface

+ VisitURLEncodedExampleResponse func(w http.ResponseWriter) error

+ type URLEncodedExampledefaultResponse struct

+ StatusCode int

+ func (response URLEncodedExampledefaultResponse) VisitURLEncodedExampleResponse(w http.ResponseWriter) error

+ type UnknownExample200Videomp4Response struct

+ Body io.Reader

+ ContentLength int64

+ func (response UnknownExample200Videomp4Response) VisitUnknownExampleResponse(w http.ResponseWriter) error

+ type UnknownExample400Response = BadrequestResponse

+ func (response UnknownExample400Response) VisitUnknownExampleResponse(w http.ResponseWriter) error

+ type UnknownExampleRequestObject struct

+ Body io.Reader

+ type UnknownExampleResponseObject interface

+ VisitUnknownExampleResponse func(w http.ResponseWriter) error

+ type UnknownExampledefaultResponse struct

+ StatusCode int

+ func (response UnknownExampledefaultResponse) VisitUnknownExampleResponse(w http.ResponseWriter) error

+ type UnspecifiedContentType200VideoResponse struct

+ Body io.Reader

+ ContentLength int64

+ ContentType string

+ func (response UnspecifiedContentType200VideoResponse) VisitUnspecifiedContentTypeResponse(w http.ResponseWriter) error

+ type UnspecifiedContentType400Response = BadrequestResponse

+ func (response UnspecifiedContentType400Response) VisitUnspecifiedContentTypeResponse(w http.ResponseWriter) error

+ type UnspecifiedContentType401Response struct

+ func (response UnspecifiedContentType401Response) VisitUnspecifiedContentTypeResponse(w http.ResponseWriter) error

+ type UnspecifiedContentType403Response struct

+ func (response UnspecifiedContentType403Response) VisitUnspecifiedContentTypeResponse(w http.ResponseWriter) error

+ type UnspecifiedContentTypeRequestObject struct

+ Body io.Reader

+ ContentType string

+ type UnspecifiedContentTypeResponseObject interface

+ VisitUnspecifiedContentTypeResponse func(w http.ResponseWriter) error

+ type UnspecifiedContentTypedefaultResponse struct

+ StatusCode int

+ func (response UnspecifiedContentTypedefaultResponse) VisitUnspecifiedContentTypeResponse(w http.ResponseWriter) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL