Back to godoc.org

Package client

v1.3.13
Latest Go to latest

The latest major version is .

Published: Aug 14, 2020 | License: Apache-2.0 | Module: github.com/marvell/oapi-codegen

Overview

Package client provides primitives to interact the openapi HTTP API.

Code generated by github.com/marvell/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 NewGetJsonWithTrailingSlashRequest

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

NewGetJsonWithTrailingSlashRequest generates requests for GetJsonWithTrailingSlash

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 RegisterHandlers

func RegisterHandlers(router 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

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A callback for modifying requests which are generated before sending over
	// the network.
	RequestEditor 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) 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) GetJsonWithTrailingSlash

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

func (*Client) GetOther

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

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 {
	// 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)

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

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

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) (*GetBothResponse, error)

GetBothWithResponse request returning *GetBothResponse

func (*ClientWithResponses) GetJsonWithResponse

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

GetJsonWithResponse request returning *GetJsonResponse

func (*ClientWithResponses) GetJsonWithTrailingSlashWithResponse

func (c *ClientWithResponses) GetJsonWithTrailingSlashWithResponse(ctx context.Context) (*GetJsonWithTrailingSlashResponse, error)

GetJsonWithTrailingSlashWithResponse request returning *GetJsonWithTrailingSlashResponse

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 ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// PostBoth request  with any body
	PostBothWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*PostBothResponse, error)

	PostBothWithResponse(ctx context.Context, body PostBothJSONRequestBody) (*PostBothResponse, error)

	// GetBoth request
	GetBothWithResponse(ctx context.Context) (*GetBothResponse, error)

	// PostJson request  with any body
	PostJsonWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*PostJsonResponse, error)

	PostJsonWithResponse(ctx context.Context, body PostJsonJSONRequestBody) (*PostJsonResponse, error)

	// GetJson request
	GetJsonWithResponse(ctx context.Context) (*GetJsonResponse, error)

	// PostOther request  with any body
	PostOtherWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*PostOtherResponse, error)

	// GetOther request
	GetOtherWithResponse(ctx context.Context) (*GetOtherResponse, error)

	// GetJsonWithTrailingSlash request
	GetJsonWithTrailingSlashWithResponse(ctx context.Context) (*GetJsonWithTrailingSlashResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

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 GetBothResponse

type GetBothResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

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

type GetJsonResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

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

type GetJsonWithTrailingSlashResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

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

type GetOtherResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

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 HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

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 PostBothResponse

type PostBothResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

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

PostJsonRequestBody defines body for PostJson for application/json ContentType.

type PostJsonResponse

type PostJsonResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

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

type PostOtherResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

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

type RequestEditorFn func(ctx context.Context, req *http.Request) 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

	// (GET /with_trailing_slash/)
	GetJsonWithTrailingSlash(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) GetJsonWithTrailingSlash

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

GetJsonWithTrailingSlash 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