customclienttype

Documentation

Overview

Package customclienttype provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version (devel) DO NOT EDIT.

Index

• func NewGetClientRequest(server string) (*http.Request, error)
• type Client
• type ClientInterface
• type ClientOption
  • func WithBaseURL(baseURL string) ClientOption
  • func WithHTTPClient(doer HttpRequestDoer) ClientOption
  • func WithRequestEditorFn(fn RequestEditorFn) ClientOption
• type ClientWithResponses
  • func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
  • func (c *ClientWithResponses) GetClientWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetClientResponse, error)
• type ClientWithResponsesInterface
• type CustomClientType
  • func NewClient(server string, opts ...ClientOption) (*CustomClientType, error)
  • func (c *CustomClientType) GetClient(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
• type GetClientResponse
  • func ParseGetClientResponse(rsp *http.Response) (*GetClientResponse, error)
  • func (r GetClientResponse) Status() string
  • func (r GetClientResponse) StatusCode() int
• type HttpRequestDoer
• type RequestEditorFn

Functions

func NewGetClientRequest

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

NewGetClientRequest generates requests for GetClient

Types

type Client

type Client struct {
	Name string `json:"name"`
}

Client defines model for Client.

type ClientInterface

type ClientInterface interface {
	// GetClient request
	GetClient(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*CustomClientType) 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) GetClientWithResponse

func (c *ClientWithResponses) GetClientWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetClientResponse, error)

GetClientWithResponse request returning *GetClientResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetClientWithResponse request
	GetClientWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetClientResponse, error)
}

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

type CustomClientType

type CustomClientType 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
}

CustomClientType which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*CustomClientType, error)

Creates a new CustomClientType, with reasonable defaults

func (*CustomClientType) GetClient

func (c *CustomClientType) GetClient(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

type GetClientResponse

type GetClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Client
}

func ParseGetClientResponse

func ParseGetClientResponse(rsp *http.Response) (*GetClientResponse, error)

ParseGetClientResponse parses an HTTP response from a GetClientWithResponse call

func (GetClientResponse) Status

func (r GetClientResponse) Status() string

Status returns HTTPResponse.Status

func (GetClientResponse) StatusCode

func (r GetClientResponse) 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 RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function