Documentation
¶
Index ¶
- func WithBasicAuth(username string, password string) httpclientcontract.RequestOption
- func WithBearerToken(token string) httpclientcontract.RequestOption
- func WithBody(body any) httpclientcontract.RequestOption
- func WithHeader(key string, value string) httpclientcontract.RequestOption
- func WithHeaders(headers map[string]string) httpclientcontract.RequestOption
- func WithJson(data any) httpclientcontract.RequestOption
- func WithMaxResponseBodyBytes(maxResponseBodyBytes int) httpclientcontract.RequestOption
- func WithQuery(key string, value string) httpclientcontract.RequestOption
- func WithQueryParams(parameters map[string]string) httpclientcontract.RequestOption
- func WithTimeout(timeout time.Duration) httpclientcontract.RequestOption
- type AuthorizationOptions
- func (instance *AuthorizationOptions) Basic() httpclientcontract.BasicAuthorizationOptions
- func (instance *AuthorizationOptions) Bearer() string
- func (instance *AuthorizationOptions) SetBasic(basic httpclientcontract.BasicAuthorizationOptions)
- func (instance *AuthorizationOptions) SetBearer(bearer string)
- type BasicAuthorizationOptions
- type HttpClient
- func (instance *HttpClient) Delete(urlString string, options ...httpclientcontract.RequestOption) (httpclientcontract.Response, error)
- func (instance *HttpClient) Get(urlString string, options ...httpclientcontract.RequestOption) (httpclientcontract.Response, error)
- func (instance *HttpClient) Patch(urlString string, body any, options ...httpclientcontract.RequestOption) (httpclientcontract.Response, error)
- func (instance *HttpClient) Post(urlString string, body any, options ...httpclientcontract.RequestOption) (httpclientcontract.Response, error)
- func (instance *HttpClient) Put(urlString string, body any, options ...httpclientcontract.RequestOption) (httpclientcontract.Response, error)
- func (instance *HttpClient) Request(method string, urlString string, options ...httpclientcontract.RequestOption) (httpclientcontract.Response, error)
- func (instance *HttpClient) RequestStream(method string, urlString string, options ...httpclientcontract.RequestOption) (httpclientcontract.StreamResponse, error)
- func (instance *HttpClient) SetBaseUrl(baseUrl string)
- func (instance *HttpClient) SetHeader(key string, value string)
- func (instance *HttpClient) SetTimeout(timeout time.Duration)
- type HttpClientConfig
- type RequestOptions
- func (instance *RequestOptions) Authorization() httpclientcontract.AuthorizationOptions
- func (instance *RequestOptions) Body() any
- func (instance *RequestOptions) ContentType() string
- func (instance *RequestOptions) Headers() map[string]string
- func (instance *RequestOptions) MaxResponseBodyBytes() int
- func (instance *RequestOptions) Query() map[string]string
- func (instance *RequestOptions) SetBasicAuth(username string, password string)
- func (instance *RequestOptions) SetBearerToken(token string)
- func (instance *RequestOptions) SetBody(body any)
- func (instance *RequestOptions) SetHeader(key string, value string)
- func (instance *RequestOptions) SetHeaders(headers map[string]string)
- func (instance *RequestOptions) SetJson(data any)
- func (instance *RequestOptions) SetMaxResponseBodyBytes(maxResponseBodyBytes int)
- func (instance *RequestOptions) SetQuery(key string, value string)
- func (instance *RequestOptions) SetQueryParams(parameters map[string]string)
- func (instance *RequestOptions) SetTimeout(timeout time.Duration)
- func (instance *RequestOptions) Timeout() time.Duration
- type Response
- func (instance *Response) Body() []byte
- func (instance *Response) Headers() nethttp.Header
- func (instance *Response) IsClientError() bool
- func (instance *Response) IsServerError() bool
- func (instance *Response) IsSuccess() bool
- func (instance *Response) Json(target any) error
- func (instance *Response) Request() *nethttp.Request
- func (instance *Response) Status() string
- func (instance *Response) StatusCode() int
- func (instance *Response) String() string
- type StreamResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func WithBasicAuth ¶
func WithBasicAuth(username string, password string) httpclientcontract.RequestOption
func WithBearerToken ¶
func WithBearerToken(token string) httpclientcontract.RequestOption
func WithBody ¶
func WithBody(body any) httpclientcontract.RequestOption
func WithHeader ¶
func WithHeader(key string, value string) httpclientcontract.RequestOption
func WithHeaders ¶
func WithHeaders(headers map[string]string) httpclientcontract.RequestOption
func WithJson ¶
func WithJson(data any) httpclientcontract.RequestOption
func WithMaxResponseBodyBytes ¶
func WithMaxResponseBodyBytes(maxResponseBodyBytes int) httpclientcontract.RequestOption
func WithQuery ¶
func WithQuery(key string, value string) httpclientcontract.RequestOption
func WithQueryParams ¶
func WithQueryParams(parameters map[string]string) httpclientcontract.RequestOption
func WithTimeout ¶
func WithTimeout(timeout time.Duration) httpclientcontract.RequestOption
Types ¶
type AuthorizationOptions ¶
type AuthorizationOptions struct {
// contains filtered or unexported fields
}
func NewAuthorizationOptions ¶
func NewAuthorizationOptions() *AuthorizationOptions
func (*AuthorizationOptions) Basic ¶
func (instance *AuthorizationOptions) Basic() httpclientcontract.BasicAuthorizationOptions
func (*AuthorizationOptions) Bearer ¶
func (instance *AuthorizationOptions) Bearer() string
func (*AuthorizationOptions) SetBasic ¶
func (instance *AuthorizationOptions) SetBasic(basic httpclientcontract.BasicAuthorizationOptions)
func (*AuthorizationOptions) SetBearer ¶
func (instance *AuthorizationOptions) SetBearer(bearer string)
type BasicAuthorizationOptions ¶
type BasicAuthorizationOptions struct {
// contains filtered or unexported fields
}
func (*BasicAuthorizationOptions) Password ¶
func (instance *BasicAuthorizationOptions) Password() string
func (*BasicAuthorizationOptions) SetPassword ¶
func (instance *BasicAuthorizationOptions) SetPassword(password string)
func (*BasicAuthorizationOptions) SetUsername ¶
func (instance *BasicAuthorizationOptions) SetUsername(username string)
func (*BasicAuthorizationOptions) Username ¶
func (instance *BasicAuthorizationOptions) Username() string
type HttpClient ¶
type HttpClient struct {
// contains filtered or unexported fields
}
func NewDefaultHttpClient ¶
func NewDefaultHttpClient() *HttpClient
func NewHttpClient ¶
func NewHttpClient(config *HttpClientConfig) *HttpClient
func (*HttpClient) Delete ¶
func (instance *HttpClient) Delete(urlString string, options ...httpclientcontract.RequestOption) (httpclientcontract.Response, error)
func (*HttpClient) Get ¶
func (instance *HttpClient) Get(urlString string, options ...httpclientcontract.RequestOption) (httpclientcontract.Response, error)
func (*HttpClient) Patch ¶
func (instance *HttpClient) Patch(urlString string, body any, options ...httpclientcontract.RequestOption) (httpclientcontract.Response, error)
func (*HttpClient) Post ¶
func (instance *HttpClient) Post(urlString string, body any, options ...httpclientcontract.RequestOption) (httpclientcontract.Response, error)
func (*HttpClient) Put ¶
func (instance *HttpClient) Put(urlString string, body any, options ...httpclientcontract.RequestOption) (httpclientcontract.Response, error)
func (*HttpClient) Request ¶
func (instance *HttpClient) Request(method string, urlString string, options ...httpclientcontract.RequestOption) (httpclientcontract.Response, error)
func (*HttpClient) RequestStream ¶
func (instance *HttpClient) RequestStream( method string, urlString string, options ...httpclientcontract.RequestOption, ) (httpclientcontract.StreamResponse, error)
func (*HttpClient) SetBaseUrl ¶
func (instance *HttpClient) SetBaseUrl(baseUrl string)
func (*HttpClient) SetHeader ¶
func (instance *HttpClient) SetHeader(key string, value string)
func (*HttpClient) SetTimeout ¶
func (instance *HttpClient) SetTimeout(timeout time.Duration)
type HttpClientConfig ¶
type HttpClientConfig struct {
// contains filtered or unexported fields
}
func NewHttpClientConfig ¶
func (*HttpClientConfig) BaseUrl ¶
func (instance *HttpClientConfig) BaseUrl() string
func (*HttpClientConfig) Headers ¶
func (instance *HttpClientConfig) Headers() map[string]string
func (*HttpClientConfig) Timeout ¶
func (instance *HttpClientConfig) Timeout() time.Duration
type RequestOptions ¶
type RequestOptions struct {
// contains filtered or unexported fields
}
func NewRequestOptions ¶
func NewRequestOptions() *RequestOptions
func (*RequestOptions) Authorization ¶
func (instance *RequestOptions) Authorization() httpclientcontract.AuthorizationOptions
func (*RequestOptions) Body ¶
func (instance *RequestOptions) Body() any
func (*RequestOptions) ContentType ¶
func (instance *RequestOptions) ContentType() string
func (*RequestOptions) Headers ¶
func (instance *RequestOptions) Headers() map[string]string
func (*RequestOptions) MaxResponseBodyBytes ¶
func (instance *RequestOptions) MaxResponseBodyBytes() int
func (*RequestOptions) Query ¶
func (instance *RequestOptions) Query() map[string]string
func (*RequestOptions) SetBasicAuth ¶
func (instance *RequestOptions) SetBasicAuth(username string, password string)
func (*RequestOptions) SetBearerToken ¶
func (instance *RequestOptions) SetBearerToken(token string)
func (*RequestOptions) SetBody ¶
func (instance *RequestOptions) SetBody(body any)
func (*RequestOptions) SetHeader ¶
func (instance *RequestOptions) SetHeader(key string, value string)
func (*RequestOptions) SetHeaders ¶
func (instance *RequestOptions) SetHeaders(headers map[string]string)
func (*RequestOptions) SetJson ¶
func (instance *RequestOptions) SetJson(data any)
func (*RequestOptions) SetMaxResponseBodyBytes ¶
func (instance *RequestOptions) SetMaxResponseBodyBytes(maxResponseBodyBytes int)
func (*RequestOptions) SetQuery ¶
func (instance *RequestOptions) SetQuery(key string, value string)
func (*RequestOptions) SetQueryParams ¶
func (instance *RequestOptions) SetQueryParams(parameters map[string]string)
func (*RequestOptions) SetTimeout ¶
func (instance *RequestOptions) SetTimeout(timeout time.Duration)
func (*RequestOptions) Timeout ¶
func (instance *RequestOptions) Timeout() time.Duration
type Response ¶
type Response struct {
// contains filtered or unexported fields
}
func NewResponse ¶
func (*Response) IsClientError ¶
func (*Response) IsServerError ¶
func (*Response) StatusCode ¶
type StreamResponse ¶
type StreamResponse struct {
// contains filtered or unexported fields
}
func NewStreamResponse ¶
func NewStreamResponse(statusCode int, headers nethttp.Header, body io.ReadCloser) *StreamResponse
func (*StreamResponse) Body ¶
func (instance *StreamResponse) Body() io.ReadCloser
func (*StreamResponse) Close ¶
func (instance *StreamResponse) Close() error
func (*StreamResponse) Headers ¶
func (instance *StreamResponse) Headers() nethttp.Header
func (*StreamResponse) StatusCode ¶
func (instance *StreamResponse) StatusCode() int
Source Files
¶
Click to show internal directories.
Click to hide internal directories.