Deprecated: use github.com/deepmap/oapi-codegen/v2 as major version v1 is no longer maintained. The upgrade path is smooth (see https://github.com/deepmap/oapi-codegen/releases/tag/v2.0.0 for more details) and only introduces a reduced set of dependencies, as well as future releases introducing a large number of enhancements and bug fixes
The highest tagged major version is
Documentation
¶
Overview ¶
Package issue_52 provides primitives to interact the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen DO NOT EDIT.
Index ¶
- func GetSwagger() (*openapi3.Swagger, error)
- func NewExampleGetRequest(server string) (*http.Request, error)
- func ParseexampleGetResponse(rsp *http.Response) (*exampleGetResponse, error)
- func RegisterHandlers(router interface{ ... }, si ServerInterface)
- type ArrayValue
- type Client
- type ClientInterface
- type ClientOption
- func WithBaseURL(baseURL string) ClientOption
- func WithHTTPClient(httpClient *http.Client) ClientOption
- func WithIdleTimeout(timeout time.Duration) ClientOption
- func WithMaxIdleConnections(maxIdleConns uint) ClientOption
- func WithRequestEditorFn(fn RequestEditorFn) ClientOption
- func WithRequestTimeout(timeout time.Duration) ClientOption
- func WithUserAgent(userAgent string) ClientOption
- type ClientWithResponses
- type Document
- type Document_Fields
- 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.
func NewExampleGetRequest ¶
NewExampleGetRequest generates requests for ExampleGet
func ParseexampleGetResponse ¶
ParseexampleGetResponse parses an HTTP response from a ExampleGetWithResponse call
func RegisterHandlers ¶
func RegisterHandlers(router 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
}, si ServerInterface)
RegisterHandlers adds each server route to the EchoRouter.
Types ¶
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example.
Server string
// HTTP client with any customized settings, such as certificate chains.
Client *http.Client
// A callback for modifying requests which are generated before sending over
// the network.
RequestEditor RequestEditorFn
// contains filtered or unexported fields
}
Client which conforms to the OpenAPI3 specification for this service.
type ClientInterface ¶
type ClientInterface interface {
// ExampleGet request
ExampleGet(ctx context.Context) (*http.Response, error)
}
The interface specification for the client above.
type ClientOption ¶ added in v1.3.1
ClientOption allows setting custom parameters during construction
func WithBaseURL ¶ added in v1.3.1
func WithBaseURL(baseURL string) ClientOption
WithBaseURL overrides the baseURL.
func WithHTTPClient ¶ added in v1.3.1
func WithHTTPClient(httpClient *http.Client) ClientOption
WithHTTPClient allows overriding the default httpClient, which is automatically created. This is useful for tests.
func WithIdleTimeout ¶ added in v1.3.1
func WithIdleTimeout(timeout time.Duration) ClientOption
WithIdleTimeout overrides the timeout of idle connections.
func WithMaxIdleConnections ¶ added in v1.3.1
func WithMaxIdleConnections(maxIdleConns uint) ClientOption
WithMaxIdleConnections overrides the amount of idle connections of the underlying http-client.
func WithRequestEditorFn ¶ added in v1.3.1
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.
func WithRequestTimeout ¶ added in v1.3.1
func WithRequestTimeout(timeout time.Duration) ClientOption
WithRequestTimeout overrides the timeout of individual requests.
func WithUserAgent ¶ added in v1.3.1
func WithUserAgent(userAgent string) ClientOption
WithUserAgent allows setting the userAgent
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClient ¶ added in v1.3.1
func NewClient(ctx context.Context, opts ...ClientOption) (*ClientWithResponses, error)
NewClient creates a new Client.
func NewClientWithResponses ¶
func NewClientWithResponses(server string) *ClientWithResponses
NewClientWithResponses returns a ClientWithResponses with a default Client:
func NewClientWithResponsesAndRequestEditorFunc ¶
func NewClientWithResponsesAndRequestEditorFunc(server string, reqEditorFn RequestEditorFn) *ClientWithResponses
NewClientWithResponsesAndRequestEditorFunc takes in a RequestEditorFn callback function and returns a ClientWithResponses with a default Client:
func (*ClientWithResponses) ExampleGetWithResponse ¶
func (c *ClientWithResponses) ExampleGetWithResponse(ctx context.Context) (*exampleGetResponse, error)
ExampleGetWithResponse request returning *ExampleGetResponse
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 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.
Source Files