Documentation
¶
Overview ¶
Package client provides primitives to interact with the openapi HTTP API.
Code generated by github.com/cparta/oapi-codegen version (devel) DO NOT EDIT.
Index ¶
- Constants
- func NewGetBothRequest(server string) (*http.Request, error)
- func NewGetJsonRequest(server string) (*http.Request, error)
- func NewGetJsonWithTrailingSlashRequest(server string) (*http.Request, error)
- func NewGetOtherRequest(server string) (*http.Request, error)
- func NewPostBothRequest(server string, body PostBothJSONRequestBody) (*http.Request, error)
- func NewPostBothRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostJsonRequest(server string, body PostJsonJSONRequestBody) (*http.Request, error)
- func NewPostJsonRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostOtherRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func RegisterHandlers(router gin.IRouter, si ServerInterface) gin.IRouter
- func RegisterHandlersWithOptions(router gin.IRouter, si ServerInterface, options GinServerOptions) gin.IRouter
- type Client
- func (c *Client) GetBoth(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetJson(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetJsonWithTrailingSlash(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetOther(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) PostBoth(ctx context.Context, body PostBothJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PostBothWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostJson(ctx context.Context, body PostJsonJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PostJsonWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostOtherWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) GetBothWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetBothResponse, error)
- func (c *ClientWithResponses) GetJsonWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetJsonResponse, error)
- func (c *ClientWithResponses) GetJsonWithTrailingSlashWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetJsonWithTrailingSlashResponse, error)
- func (c *ClientWithResponses) GetOtherWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOtherResponse, error)
- func (c *ClientWithResponses) PostBothWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*PostBothResponse, error)
- func (c *ClientWithResponses) PostBothWithResponse(ctx context.Context, body PostBothJSONRequestBody, ...) (*PostBothResponse, error)
- func (c *ClientWithResponses) PostJsonWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*PostJsonResponse, error)
- func (c *ClientWithResponses) PostJsonWithResponse(ctx context.Context, body PostJsonJSONRequestBody, ...) (*PostJsonResponse, error)
- func (c *ClientWithResponses) PostOtherWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*PostOtherResponse, error)
- type ClientWithResponsesInterface
- type GetBothResponse
- type GetJsonResponse
- type GetJsonWithTrailingSlashResponse
- type GetOtherResponse
- type GinServerOptions
- type HttpRequestDoer
- type MiddlewareFunc
- type PostBothJSONBody
- type PostBothJSONRequestBody
- type PostBothResponse
- type PostJsonJSONBody
- type PostJsonJSONRequestBody
- type PostJsonResponse
- type PostOtherResponse
- type RequestEditorFn
- type SchemaObject
- type ServerInterface
- type ServerInterfaceWrapper
- func (siw *ServerInterfaceWrapper) GetBoth(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetJson(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetJsonWithTrailingSlash(c *gin.Context)
- func (siw *ServerInterfaceWrapper) GetOther(c *gin.Context)
- func (siw *ServerInterfaceWrapper) PostBoth(c *gin.Context)
- func (siw *ServerInterfaceWrapper) PostJson(c *gin.Context)
- func (siw *ServerInterfaceWrapper) PostOther(c *gin.Context)
Constants ¶
const (
OpenIdScopes = "OpenId.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
func NewGetBothRequest ¶
NewGetBothRequest generates requests for GetBoth
func NewGetJsonRequest ¶
NewGetJsonRequest generates requests for GetJson
func NewGetJsonWithTrailingSlashRequest ¶
NewGetJsonWithTrailingSlashRequest generates requests for GetJsonWithTrailingSlash
func NewGetOtherRequest ¶
NewGetOtherRequest generates requests for GetOther
func NewPostBothRequest ¶
func NewPostBothRequest(server string, body PostBothJSONRequestBody) (*http.Request, error)
NewPostBothRequest calls the generic PostBoth builder with application/json body
func NewPostBothRequestWithBody ¶
func NewPostBothRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewPostBothRequestWithBody generates requests for PostBoth with any type of body
func NewPostJsonRequest ¶
func NewPostJsonRequest(server string, body PostJsonJSONRequestBody) (*http.Request, error)
NewPostJsonRequest calls the generic PostJson builder with application/json body
func NewPostJsonRequestWithBody ¶
func NewPostJsonRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewPostJsonRequestWithBody generates requests for PostJson with any type of body
func NewPostOtherRequestWithBody ¶
func NewPostOtherRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewPostOtherRequestWithBody generates requests for PostOther with any type of body
func RegisterHandlers ¶
func RegisterHandlers(router gin.IRouter, si ServerInterface) gin.IRouter
RegisterHandlers creates http.Handler with routing matching OpenAPI spec.
func RegisterHandlersWithOptions ¶ added in v1.9.3
func RegisterHandlersWithOptions(router gin.IRouter, si ServerInterface, options GinServerOptions) gin.IRouter
RegisterHandlersWithOptions creates http.Handler with additional options
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) GetJsonWithTrailingSlash ¶
func (*Client) PostBoth ¶
func (c *Client) PostBoth(ctx context.Context, body PostBothJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostBothWithBody ¶
func (*Client) PostJson ¶
func (c *Client) PostJson(ctx context.Context, body PostJsonJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostJsonWithBody ¶
type ClientInterface ¶
type ClientInterface interface {
// PostBoth request with any body
PostBothWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostBoth(ctx context.Context, body PostBothJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetBoth request
GetBoth(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostJson request with any body
PostJsonWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostJson(ctx context.Context, body PostJsonJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetJson request
GetJson(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostOther request with any body
PostOtherWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetOther request
GetOther(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetJsonWithTrailingSlash request
GetJsonWithTrailingSlash(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) GetBothWithResponse ¶
func (c *ClientWithResponses) GetBothWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetBothResponse, error)
GetBothWithResponse request returning *GetBothResponse
func (*ClientWithResponses) GetJsonWithResponse ¶
func (c *ClientWithResponses) GetJsonWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetJsonResponse, error)
GetJsonWithResponse request returning *GetJsonResponse
func (*ClientWithResponses) GetJsonWithTrailingSlashWithResponse ¶
func (c *ClientWithResponses) GetJsonWithTrailingSlashWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetJsonWithTrailingSlashResponse, error)
GetJsonWithTrailingSlashWithResponse request returning *GetJsonWithTrailingSlashResponse
func (*ClientWithResponses) GetOtherWithResponse ¶
func (c *ClientWithResponses) GetOtherWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOtherResponse, error)
GetOtherWithResponse request returning *GetOtherResponse
func (*ClientWithResponses) PostBothWithBodyWithResponse ¶
func (c *ClientWithResponses) PostBothWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostBothResponse, error)
PostBothWithBodyWithResponse request with arbitrary body returning *PostBothResponse
func (*ClientWithResponses) PostBothWithResponse ¶
func (c *ClientWithResponses) PostBothWithResponse(ctx context.Context, body PostBothJSONRequestBody, reqEditors ...RequestEditorFn) (*PostBothResponse, error)
func (*ClientWithResponses) PostJsonWithBodyWithResponse ¶
func (c *ClientWithResponses) PostJsonWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostJsonResponse, error)
PostJsonWithBodyWithResponse request with arbitrary body returning *PostJsonResponse
func (*ClientWithResponses) PostJsonWithResponse ¶
func (c *ClientWithResponses) PostJsonWithResponse(ctx context.Context, body PostJsonJSONRequestBody, reqEditors ...RequestEditorFn) (*PostJsonResponse, error)
func (*ClientWithResponses) PostOtherWithBodyWithResponse ¶
func (c *ClientWithResponses) PostOtherWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostOtherResponse, error)
PostOtherWithBodyWithResponse request with arbitrary body returning *PostOtherResponse
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// PostBoth request with any body
PostBothWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostBothResponse, error)
PostBothWithResponse(ctx context.Context, body PostBothJSONRequestBody, reqEditors ...RequestEditorFn) (*PostBothResponse, error)
// GetBoth request
GetBothWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetBothResponse, error)
// PostJson request with any body
PostJsonWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostJsonResponse, error)
PostJsonWithResponse(ctx context.Context, body PostJsonJSONRequestBody, reqEditors ...RequestEditorFn) (*PostJsonResponse, error)
// GetJson request
GetJsonWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetJsonResponse, error)
// PostOther request with any body
PostOtherWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostOtherResponse, error)
// GetOther request
GetOtherWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOtherResponse, error)
// GetJsonWithTrailingSlash request
GetJsonWithTrailingSlashWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetJsonWithTrailingSlashResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type GetBothResponse ¶
func ParseGetBothResponse ¶
func ParseGetBothResponse(rsp *http.Response) (*GetBothResponse, error)
ParseGetBothResponse parses an HTTP response from a GetBothWithResponse call
func (GetBothResponse) Status ¶
func (r GetBothResponse) Status() string
Status returns HTTPResponse.Status
func (GetBothResponse) StatusCode ¶
func (r GetBothResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetJsonResponse ¶
func ParseGetJsonResponse ¶
func ParseGetJsonResponse(rsp *http.Response) (*GetJsonResponse, error)
ParseGetJsonResponse parses an HTTP response from a GetJsonWithResponse call
func (GetJsonResponse) Status ¶
func (r GetJsonResponse) Status() string
Status returns HTTPResponse.Status
func (GetJsonResponse) StatusCode ¶
func (r GetJsonResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetJsonWithTrailingSlashResponse ¶
func ParseGetJsonWithTrailingSlashResponse ¶
func ParseGetJsonWithTrailingSlashResponse(rsp *http.Response) (*GetJsonWithTrailingSlashResponse, error)
ParseGetJsonWithTrailingSlashResponse parses an HTTP response from a GetJsonWithTrailingSlashWithResponse call
func (GetJsonWithTrailingSlashResponse) Status ¶
func (r GetJsonWithTrailingSlashResponse) Status() string
Status returns HTTPResponse.Status
func (GetJsonWithTrailingSlashResponse) StatusCode ¶
func (r GetJsonWithTrailingSlashResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetOtherResponse ¶
func ParseGetOtherResponse ¶
func ParseGetOtherResponse(rsp *http.Response) (*GetOtherResponse, error)
ParseGetOtherResponse parses an HTTP response from a GetOtherWithResponse call
func (GetOtherResponse) Status ¶
func (r GetOtherResponse) Status() string
Status returns HTTPResponse.Status
func (GetOtherResponse) StatusCode ¶
func (r GetOtherResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GinServerOptions ¶ added in v1.9.3
type GinServerOptions struct {
BaseURL string
Middlewares []gin.HandlerFunc
}
GinServerOptions provides options for the Gin server.
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type MiddlewareFunc ¶ added in v1.9.3
type MiddlewareFunc = gin.HandlerFunc
keeping for backward compatibility
type PostBothJSONBody ¶
type PostBothJSONBody SchemaObject
PostBothJSONBody defines parameters for PostBoth.
type PostBothJSONRequestBody ¶
type PostBothJSONRequestBody PostBothJSONBody
PostBothJSONRequestBody defines body for PostBoth for application/json ContentType.
type PostBothResponse ¶
func ParsePostBothResponse ¶
func ParsePostBothResponse(rsp *http.Response) (*PostBothResponse, error)
ParsePostBothResponse parses an HTTP response from a PostBothWithResponse call
func (PostBothResponse) Status ¶
func (r PostBothResponse) Status() string
Status returns HTTPResponse.Status
func (PostBothResponse) StatusCode ¶
func (r PostBothResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostJsonJSONBody ¶
type PostJsonJSONBody SchemaObject
PostJsonJSONBody defines parameters for PostJson.
type PostJsonJSONRequestBody ¶
type PostJsonJSONRequestBody PostJsonJSONBody
PostJsonJSONRequestBody defines body for PostJson for application/json ContentType.
type PostJsonResponse ¶
func ParsePostJsonResponse ¶
func ParsePostJsonResponse(rsp *http.Response) (*PostJsonResponse, error)
ParsePostJsonResponse parses an HTTP response from a PostJsonWithResponse call
func (PostJsonResponse) Status ¶
func (r PostJsonResponse) Status() string
Status returns HTTPResponse.Status
func (PostJsonResponse) StatusCode ¶
func (r PostJsonResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostOtherResponse ¶
func ParsePostOtherResponse ¶
func ParsePostOtherResponse(rsp *http.Response) (*PostOtherResponse, error)
ParsePostOtherResponse parses an HTTP response from a PostOtherWithResponse call
func (PostOtherResponse) Status ¶
func (r PostOtherResponse) Status() string
Status returns HTTPResponse.Status
func (PostOtherResponse) StatusCode ¶
func (r PostOtherResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type SchemaObject ¶
SchemaObject defines model for SchemaObject.
type ServerInterface ¶
type ServerInterface interface {
// (POST /with_both_bodies)
PostBoth(c *gin.Context)
// (GET /with_both_responses)
GetBoth(c *gin.Context)
// (POST /with_json_body)
PostJson(c *gin.Context)
// (GET /with_json_response)
GetJson(c *gin.Context)
// (POST /with_other_body)
PostOther(c *gin.Context)
// (GET /with_other_response)
GetOther(c *gin.Context)
// (GET /with_trailing_slash/)
GetJsonWithTrailingSlash(c *gin.Context)
}
ServerInterface represents all server handlers.
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
}
ServerInterfaceWrapper converts contexts to parameters.
func (*ServerInterfaceWrapper) GetBoth ¶
func (siw *ServerInterfaceWrapper) GetBoth(c *gin.Context)
GetBoth operation middleware
func (*ServerInterfaceWrapper) GetJson ¶
func (siw *ServerInterfaceWrapper) GetJson(c *gin.Context)
GetJson operation middleware
func (*ServerInterfaceWrapper) GetJsonWithTrailingSlash ¶
func (siw *ServerInterfaceWrapper) GetJsonWithTrailingSlash(c *gin.Context)
GetJsonWithTrailingSlash operation middleware
func (*ServerInterfaceWrapper) GetOther ¶
func (siw *ServerInterfaceWrapper) GetOther(c *gin.Context)
GetOther operation middleware
func (*ServerInterfaceWrapper) PostBoth ¶
func (siw *ServerInterfaceWrapper) PostBoth(c *gin.Context)
PostBoth operation middleware
func (*ServerInterfaceWrapper) PostJson ¶
func (siw *ServerInterfaceWrapper) PostJson(c *gin.Context)
PostJson operation middleware
func (*ServerInterfaceWrapper) PostOther ¶
func (siw *ServerInterfaceWrapper) PostOther(c *gin.Context)
PostOther operation middleware