client

Documentation

Overview

Package client provides primitives to interact the openapi HTTP API.

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

Index

• func GetSwagger() (*openapi3.Swagger, error)
• func NewGetBothRequest(server string) (*http.Request, error)
• func NewGetJsonRequest(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 ParsegetBothResponse(rsp *http.Response) (*getBothResponse, error)
• func ParsegetJsonResponse(rsp *http.Response) (*getJsonResponse, error)
• func ParsegetOtherResponse(rsp *http.Response) (*getOtherResponse, error)
• func ParsepostBothResponse(rsp *http.Response) (*postBothResponse, error)
• func ParsepostJsonResponse(rsp *http.Response) (*postJsonResponse, error)
• func ParsepostOtherResponse(rsp *http.Response) (*postOtherResponse, error)
• func RegisterHandlers(router runtime.EchoRouter, si ServerInterface)
• type Client
  • func (c *Client) GetBoth(ctx context.Context) (*http.Response, error)
  • func (c *Client) GetJson(ctx context.Context) (*http.Response, error)
  • func (c *Client) GetOther(ctx context.Context) (*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 ClientWithResponses
  • func NewClientWithResponses(server string) *ClientWithResponses
  • func NewClientWithResponsesAndRequestEditorFunc(server string, reqEditorFn RequestEditorFn) *ClientWithResponses
  • func (c *ClientWithResponses) GetBothWithResponse(ctx context.Context) (*getBothResponse, error)
  • func (c *ClientWithResponses) GetJsonWithResponse(ctx context.Context) (*getJsonResponse, error)
  • func (c *ClientWithResponses) GetOtherWithResponse(ctx context.Context) (*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 PostBothJSONRequestBody
• type PostJsonJSONRequestBody
• type RequestEditorFn
• type SchemaObject
• type ServerInterface
• type ServerInterfaceWrapper
  • func (w *ServerInterfaceWrapper) GetBoth(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) GetJson(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) GetOther(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) PostBoth(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) PostJson(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) PostOther(ctx echo.Context) error

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

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
}

Client which conforms to the OpenAPI3 specification for this service.

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

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 PostBothJSONRequestBody

type PostBothJSONRequestBody SchemaObject

PostBothRequestBody defines body for PostBoth for application/json ContentType.

type PostJsonJSONRequestBody

type PostJsonJSONRequestBody SchemaObject

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
}

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.