Back to godoc.org

Package client

v1.9.2
Latest Go to latest

The highest tagged major version is .

Published: Oct 22, 2019 | License: Apache-2.0 | Module: github.com/devk-insurance/oapi-codegen

Overview

Package client provides primitives to interact the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen DO NOT EDIT.

Index

func GetSwagger

func GetSwagger() (*openapi3.Swagger, error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file.

func NewGetBothRequest

func NewGetBothRequest(server string) (*http.Request, error)

NewGetBothRequest generates requests for GetBoth

func NewGetJsonRequest

func NewGetJsonRequest(server string) (*http.Request, error)

NewGetJsonRequest generates requests for GetJson

func NewGetOtherRequest

func NewGetOtherRequest(server string) (*http.Request, error)

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 ParsegetBothResponse

func ParsegetBothResponse(rsp *http.Response) (*getBothResponse, error)

ParsegetBothResponse parses an HTTP response from a GetBothWithResponse call

func ParsegetJsonResponse

func ParsegetJsonResponse(rsp *http.Response) (*getJsonResponse, error)

ParsegetJsonResponse parses an HTTP response from a GetJsonWithResponse call

func ParsegetOtherResponse

func ParsegetOtherResponse(rsp *http.Response) (*getOtherResponse, error)

ParsegetOtherResponse parses an HTTP response from a GetOtherWithResponse call

func ParsepostBothResponse

func ParsepostBothResponse(rsp *http.Response) (*postBothResponse, error)

ParsepostBothResponse parses an HTTP response from a PostBothWithResponse call

func ParsepostJsonResponse

func ParsepostJsonResponse(rsp *http.Response) (*postJsonResponse, error)

ParsepostJsonResponse parses an HTTP response from a PostJsonWithResponse call

func ParsepostOtherResponse

func ParsepostOtherResponse(rsp *http.Response) (*postOtherResponse, error)

ParsepostOtherResponse parses an HTTP response from a PostOtherWithResponse call

func RegisterHandlers

func RegisterHandlers(router runtime.EchoRouter, si ServerInterface)

RegisterHandlers adds each server route to the EchoRouter.

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

	// A callback which gets called after request finished, before any
	// deserialization steps.
	RequestCompletion RequestCompletionFn

	// List of additional interceptors, which gets called prior
	// of the RequestEditor.
	Interceptors []Interceptor
	// contains filtered or unexported fields
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(ctx context.Context, opts ...Option) (*Client, error)

NewClient creates a new Client.

func (*Client) GetBoth

func (c *Client) GetBoth(ctx context.Context) (*http.Response, error)

func (*Client) GetJson

func (c *Client) GetJson(ctx context.Context) (*http.Response, error)

func (*Client) GetOther

func (c *Client) GetOther(ctx context.Context) (*http.Response, error)

func (*Client) Intercept

func (c *Client) Intercept(req *http.Request, ctx context.Context) error

Intercept intercepts the request, applies all registered Interceptors which are part of the client. If an Interceptor fails, the Interceptor chain will return early.

func (*Client) PostBoth

func (c *Client) PostBoth(ctx context.Context, body PostBothJSONRequestBody) (*http.Response, error)

func (*Client) PostBothWithBody

func (c *Client) PostBothWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

func (*Client) PostJson

func (c *Client) PostJson(ctx context.Context, body PostJsonJSONRequestBody) (*http.Response, error)

func (*Client) PostJsonWithBody

func (c *Client) PostJsonWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

func (*Client) PostOtherWithBody

func (c *Client) PostOtherWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

type ClientInterface

type ClientInterface interface {

	// Intercept intercepts the request, applies all registered Interceptors
	// which are part of the client.
	// If an Interceptor fails, the Interceptor chain will return early.
	Intercept(req *http.Request, ctx context.Context) error

	// PostBoth request  with any body
	PostBothWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	PostBoth(ctx context.Context, body PostBothJSONRequestBody) (*http.Response, error)

	// GetBoth request
	GetBoth(ctx context.Context) (*http.Response, error)

	// PostJson request  with any body
	PostJsonWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	PostJson(ctx context.Context, body PostJsonJSONRequestBody) (*http.Response, error)

	// GetJson request
	GetJson(ctx context.Context) (*http.Response, error)

	// PostOther request  with any body
	PostOtherWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	// GetOther request
	GetOther(ctx context.Context) (*http.Response, error)
}

The interface specification for the client above.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

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) GetBothWithResponse

func (c *ClientWithResponses) GetBothWithResponse(ctx context.Context) (*getBothResponse, error)

GetBothWithResponse request returning *GetBothResponse

func (*ClientWithResponses) GetJsonWithResponse

func (c *ClientWithResponses) GetJsonWithResponse(ctx context.Context) (*getJsonResponse, error)

GetJsonWithResponse request returning *GetJsonResponse

func (*ClientWithResponses) GetOtherWithResponse

func (c *ClientWithResponses) GetOtherWithResponse(ctx context.Context) (*getOtherResponse, error)

GetOtherWithResponse request returning *GetOtherResponse

func (*ClientWithResponses) PostBothWithBodyWithResponse

func (c *ClientWithResponses) PostBothWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*postBothResponse, error)

PostBothWithBodyWithResponse request with arbitrary body returning *PostBothResponse

func (*ClientWithResponses) PostBothWithResponse

func (c *ClientWithResponses) PostBothWithResponse(ctx context.Context, body PostBothJSONRequestBody) (*postBothResponse, error)

func (*ClientWithResponses) PostJsonWithBodyWithResponse

func (c *ClientWithResponses) PostJsonWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*postJsonResponse, error)

PostJsonWithBodyWithResponse request with arbitrary body returning *PostJsonResponse

func (*ClientWithResponses) PostJsonWithResponse

func (c *ClientWithResponses) PostJsonWithResponse(ctx context.Context, body PostJsonJSONRequestBody) (*postJsonResponse, error)

func (*ClientWithResponses) PostOtherWithBodyWithResponse

func (c *ClientWithResponses) PostOtherWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*postOtherResponse, error)

PostOtherWithBodyWithResponse request with arbitrary body returning *PostOtherResponse

type Interceptor

type Interceptor interface {
	// Intercept intercepts a request and can fail with an error.
	Intercept(req *http.Request, ctx context.Context) error
}

Interceptor allows intercepting requests.

type InterceptorFn

type InterceptorFn func(req *http.Request, ctx context.Context) error

InterceptorFn allows intercepting requests and can be used as an adapter to a Interceptor.

func (InterceptorFn) Intercept

func (f InterceptorFn) Intercept(req *http.Request, ctx context.Context) error

InterceptorFn is an adapter to allow the use of ordinary functions as Interceptors.

type Option

type Option func(*Client) error

Option allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) Option

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(httpClient *http.Client) Option

WithHTTPClient allows overriding the default httpClient, which is automatically created. This is useful for tests.

func WithIdleTimeout

func WithIdleTimeout(timeout time.Duration) Option

WithIdleTimeout overrides the timeout of idle connections.

func WithInterceptors

func WithInterceptors(interceptors ...Interceptor) Option

WithInterceptors allows adding 0..N interceptors, which get called in serial order prior of calling the RequestEditor before finally making the request. Use this function to attach authentication mechanisms.

func WithMaxIdleConnections

func WithMaxIdleConnections(maxIdleConns uint) Option

WithMaxIdleConnections overrides the amount of idle connections of the underlying http-client.

func WithRequestCompletionFn

func WithRequestCompletionFn(fn RequestCompletionFn) Option

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 WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) Option

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

func WithRequestTimeout(timeout time.Duration) Option

WithRequestTimeout overrides the timeout of individual requests.

func WithUserAgent

func WithUserAgent(userAgent string) Option

WithUserAgent allows setting the userAgent

type PostBothJSONBody

type PostBothJSONBody SchemaObject

PostBothJSONBody defines parameters for PostBoth.

type PostBothJSONRequestBody

type PostBothJSONRequestBody PostBothJSONBody

PostBothRequestBody defines body for PostBoth for application/json ContentType.

type PostJsonJSONBody

type PostJsonJSONBody SchemaObject

PostJsonJSONBody defines parameters for PostJson.

type PostJsonJSONRequestBody

type PostJsonJSONRequestBody PostJsonJSONBody

PostJsonRequestBody defines body for PostJson for application/json ContentType.

type RequestCompletionFn

type RequestCompletionFn func(req *http.Request, resp *http.Response)

RequestCompletionFn is the function signature for the RequestCompletion callback function

type RequestEditorFn

type RequestEditorFn func(req *http.Request, ctx context.Context) error

RequestEditorFn is the function signature for the RequestEditor callback function

type SchemaObject

type SchemaObject struct {
	FirstName string `json:"firstName"`
	Role      string `json:"role"`
}

SchemaObject defines model for SchemaObject.

type ServerInterface

type ServerInterface interface {
	// (POST /with_both_bodies)
	PostBoth(ctx echo.Context) error
	// (GET /with_both_responses)
	GetBoth(ctx echo.Context) error
	// (POST /with_json_body)
	PostJson(ctx echo.Context) error
	// (GET /with_json_response)
	GetJson(ctx echo.Context) error
	// (POST /with_other_body)
	PostOther(ctx echo.Context) error
	// (GET /with_other_response)
	GetOther(ctx echo.Context) error
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) GetBoth

func (w *ServerInterfaceWrapper) GetBoth(ctx echo.Context) error

GetBoth converts echo context to params.

func (*ServerInterfaceWrapper) GetJson

func (w *ServerInterfaceWrapper) GetJson(ctx echo.Context) error

GetJson converts echo context to params.

func (*ServerInterfaceWrapper) GetOther

func (w *ServerInterfaceWrapper) GetOther(ctx echo.Context) error

GetOther converts echo context to params.

func (*ServerInterfaceWrapper) PostBoth

func (w *ServerInterfaceWrapper) PostBoth(ctx echo.Context) error

PostBoth converts echo context to params.

func (*ServerInterfaceWrapper) PostJson

func (w *ServerInterfaceWrapper) PostJson(ctx echo.Context) error

PostJson converts echo context to params.

func (*ServerInterfaceWrapper) PostOther

func (w *ServerInterfaceWrapper) PostOther(ctx echo.Context) error

PostOther converts echo context to params.

Package Files

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier