Documentation
¶
Index ¶
- type Client
- func (self *Client) Do(req *http.Request, out any) error
- func (self *Client) Get(ctx context.Context, endpoint string, out any, reqEditors ...RequestEditorFn) error
- func (self *Client) NewRequest(ctx context.Context, method, endpoint string, body io.Reader, ...) (*http.Request, error)
- func (self *Client) Post(ctx context.Context, endpoint string, in, out any, ...) error
- func (self *Client) WithRequestEditorFn(fn RequestEditorFn) *Client
- type ClientOption
- type HttpRequestDoer
- type RequestEditorFn
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client 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
}
Client which conforms to the OpenAPI3 specification for this service.
func New ¶
func New(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) NewRequest ¶
func (*Client) WithRequestEditorFn ¶
func (self *Client) WithRequestEditorFn(fn RequestEditorFn) *Client
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 ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithControlPath ¶
func WithControlPath(sockPath string) ClientOption
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.
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
Source Files
Click to show internal directories.
Click to hide internal directories.