client

package
v1.3.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 22, 2022 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Overview

Package client provides primitives to interact the openapi HTTP API.

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

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 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 ParseGetJsonWithTrailingSlashResponse 

func ParseGetJsonWithTrailingSlashResponse(rsp *http.Response) (*getJsonWithTrailingSlashResponse, error)

ParseGetJsonWithTrailingSlashResponse parses an HTTP response from a GetJsonWithTrailingSlashWithResponse 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 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, m ...echo.MiddlewareFunc)

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

	// 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 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 PostJsonJSONBody 

type PostJsonJSONBody SchemaObject

PostJsonJSONBody defines parameters for PostJson.

type PostJsonJSONRequestBody 

type PostJsonJSONRequestBody PostJsonJSONBody

PostJsonRequestBody defines body for PostJson for application/json ContentType.

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

	// (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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.