Documentation ¶
Overview ¶
Package issue_52 provides primitives to interact with the openapi HTTP API.
Code generated by github.com/xenking/oapi-codegen version (devel) DO NOT EDIT.
Index ¶
- func GetSwagger() (swagger *openapi3.T, err error)
- func NewExampleGetRequest(server string) (*http.Request, 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 ArrayValue
- type Client
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- type ClientWithResponsesInterface
- type Document
- type Document_Fields
- type EchoRouter
- type ExampleGetResponse
- type HttpRequestDoer
- type RequestEditorFn
- type ServerInterface
- type ServerInterfaceWrapper
- type Value
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 NewExampleGetRequest ¶
NewExampleGetRequest generates requests for ExampleGet
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 Client ¶
type Client struct { // The endpoint of the server conforming to this interface, with scheme, // https://api.deepmap.com for example. This can contain a path relative // to the server, such as https://api.deepmap.com/dev-test, and all the // paths in the swagger spec will be appended to the server. Server string // Doer for performing requests, typically a *http.Client with any // customized settings, such as certificate chains. Client HttpRequestDoer // A list of callbacks for modifying requests which are generated before sending over // the network. RequestEditors []RequestEditorFn }
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) ExampleGet ¶
type ClientInterface ¶
type ClientInterface interface { // ExampleGet request ExampleGet(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error) }
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) ExampleGetWithResponse ¶
func (c *ClientWithResponses) ExampleGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ExampleGetResponse, error)
ExampleGetWithResponse request returning *ExampleGetResponse
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface { // ExampleGet request ExampleGetWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ExampleGetResponse, error) }
ClientWithResponsesInterface is the interface specification for the client with responses above.
type Document ¶
type Document struct {
Fields *Document_Fields `json:"fields,omitempty"`
}
Document defines model for Document.
type Document_Fields ¶
Document_Fields defines model for Document.Fields.
func (Document_Fields) Get ¶
func (a Document_Fields) Get(fieldName string) (value Value, found bool)
Getter for additional properties for Document_Fields. Returns the specified element and whether it was found
func (*Document_Fields) MarshalJSON ¶
func (a *Document_Fields) MarshalJSON() ([]byte, error)
Override default JSON handling for Document_Fields to handle AdditionalProperties
func (*Document_Fields) Set ¶
func (a *Document_Fields) Set(fieldName string, value Value)
Setter for additional properties for Document_Fields
func (*Document_Fields) UnmarshalJSON ¶
func (a *Document_Fields) UnmarshalJSON(b []byte) error
Override default JSON handling for Document_Fields to handle AdditionalProperties
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 ExampleGetResponse ¶
func ParseExampleGetResponse ¶
func ParseExampleGetResponse(rsp *http.Response) (*ExampleGetResponse, error)
ParseExampleGetResponse parses an HTTP response from a ExampleGetWithResponse call
func (ExampleGetResponse) Status ¶
func (r ExampleGetResponse) Status() string
Status returns HTTPResponse.Status
func (ExampleGetResponse) StatusCode ¶
func (r ExampleGetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type ServerInterface ¶
type ServerInterface interface { // (GET /example) ExampleGet(ctx echo.Context) error }
ServerInterface represents all server handlers.
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
}
ServerInterfaceWrapper converts echo contexts to parameters.
func (*ServerInterfaceWrapper) ExampleGet ¶
func (w *ServerInterfaceWrapper) ExampleGet(ctx echo.Context) error
ExampleGet converts echo context to params.
type Value ¶
type Value struct { ArrayValue *ArrayValue `json:"arrayValue,omitempty"` StringValue *string `json:"stringValue,omitempty"` }
Value defines model for Value.