httpx

package module

Go to main page

Versions in this module

v1

v1.0.4

Oct 29, 2026

Changes in this version

type RequestBuilder

+ func (rb *RequestBuilder) ToCURL(ctx context.Context) (string, error)

+ func (rb *RequestBuilder) ToText(ctx context.Context) (string, error)

v1.0.3

Oct 28, 2026

Changes in this version

type HTTPError

+ Decoded bool

type RequestBuilder

+ func (rb *RequestBuilder) ErrorInto(v any) *RequestBuilder

v1.0.2

Oct 28, 2026

Changes in this version

type RetryPolicy

+ func AggressiveRetryPolicy() RetryPolicy

+ func BackgroundRetryPolicy() RetryPolicy

+ func FastRetryPolicy() RetryPolicy

+ func NoRetryPolicy() RetryPolicy

+ func RateLimitRetryPolicy() RetryPolicy

+ func ResilientRetryPolicy() RetryPolicy

v1.0.1

Oct 27, 2026

Changes in this version

type RequestBuilder

+ func (rb *RequestBuilder) Do(ctx context.Context) (*Response, error)

v1.0.0

Oct 27, 2026

Changes in this version

+ const Version

+ var ErrEmptyBody = errors.New("httpx: empty response body")

+ func IsTimeout(err error) bool

+ func ToBytes(resp *Response, err error) ([]byte, error)

+ func ToJSON[T any](resp *Response, err error) (T, error)

+ func ToString(resp *Response, err error) (string, error)

+ type APIKeyAuth struct

+ Header string

+ Key string

+ func (a APIKeyAuth) Apply(req *http.Request) error

+ type APIKeyQueryAuth struct

+ Key string

+ Param string

+ func (a APIKeyQueryAuth) Apply(req *http.Request) error

+ type Auth interface

+ Apply func(req *http.Request) error

+ func NewAPIKeyAuth(header, key string) Auth

+ func NewAPIKeyQueryAuth(param, key string) Auth

+ func NewBasicAuth(username, password string) Auth

+ func NewBearerAuth(token string) Auth

+ type BasicAuth struct

+ Password string

+ Username string

+ func (b BasicAuth) Apply(req *http.Request) error

+ type BearerAuth struct

+ Token string

+ func (b BearerAuth) Apply(req *http.Request) error

+ type Client struct

+ func New(options ...Option) *Client

+ func (c *Client) Close()

+ func (c *Client) DELETE(url string) *RequestBuilder

+ func (c *Client) GET(url string) *RequestBuilder

+ func (c *Client) HEAD(url string) *RequestBuilder

+ func (c *Client) OPTIONS(url string) *RequestBuilder

+ func (c *Client) PATCH(url string) *RequestBuilder

+ func (c *Client) POST(url string) *RequestBuilder

+ func (c *Client) PUT(url string) *RequestBuilder

+ func (c *Client) QUERY(url string) *RequestBuilder

+ type HTTPError struct

+ Body string

+ Header http.Header

+ Method string

+ Status string

+ StatusCode int

+ URL string

+ func (e *HTTPError) Error() string

+ type Logger interface

+ Debug func(ctx context.Context, msg string, keysAndValues ...any)

+ Error func(ctx context.Context, msg string, keysAndValues ...any)

+ Info func(ctx context.Context, msg string, keysAndValues ...any)

+ type Middleware func(http.RoundTripper) http.RoundTripper

+ type Option func(*Client)

+ func WithAuth(auth Auth) Option

+ func WithBaseURL(baseURL string) Option

+ func WithCheckRedirect(fn func(req *http.Request, via []*http.Request) error) Option

+ func WithClientName(value string) Option

+ func WithCookieJar(jar http.CookieJar) Option

+ func WithHTTPClient(client *http.Client) Option

+ func WithHeader(key, value string) Option

+ func WithLogger(logger Logger) Option

+ func WithMaxResponseBytes(n int64) Option

+ func WithMiddleware(m ...Middleware) Option

+ func WithPoolConfig(cfg PoolConfig) Option

+ func WithProxy(proxy func(*http.Request) (*url.URL, error)) Option

+ func WithQueryParam(key, value string) Option

+ func WithRequestHook(h RequestHook) Option

+ func WithResponseHook(h ResponseHook) Option

+ func WithRetryPolicy(p RetryPolicy) Option

+ func WithTLSConfig(cfg *tls.Config) Option

+ func WithTimeout(timeout time.Duration) Option

+ func WithTracer(tracer Tracer) Option

+ func WithTransport(transport http.RoundTripper) Option

+ type PoolConfig struct

+ IdleConnTimeout time.Duration

+ MaxConnsPerHost int

+ MaxIdleConns int

+ MaxIdleConnsPerHost int

+ ResponseHeaderTimeout time.Duration

+ TLSHandshakeTimeout time.Duration

+ type RequestBuilder struct

+ func (rb *RequestBuilder) Auth(auth Auth) *RequestBuilder

+ func (rb *RequestBuilder) Body(body io.Reader) *RequestBuilder

+ func (rb *RequestBuilder) Debug() *RequestBuilder

+ func (rb *RequestBuilder) Field(key, value string) *RequestBuilder

+ func (rb *RequestBuilder) Fields(fields url.Values) *RequestBuilder

+ func (rb *RequestBuilder) File(fieldName, filePath string) *RequestBuilder

+ func (rb *RequestBuilder) FileReader(fieldName string, r io.Reader, filename string, contentType ...string) *RequestBuilder

+ func (rb *RequestBuilder) Form(fields map[string]string) *RequestBuilder

+ func (rb *RequestBuilder) FormValues(values url.Values) *RequestBuilder

+ func (rb *RequestBuilder) Header(key, value string) *RequestBuilder

+ func (rb *RequestBuilder) Headers(headers map[string]string) *RequestBuilder

+ func (rb *RequestBuilder) IdempotencyKey(key string) *RequestBuilder

+ func (rb *RequestBuilder) JSON(v any) *RequestBuilder

+ func (rb *RequestBuilder) PathParam(name, value string) *RequestBuilder

+ func (rb *RequestBuilder) QueryParam(key, value string) *RequestBuilder

+ func (rb *RequestBuilder) QueryParams(params map[string]string) *RequestBuilder

+ func (rb *RequestBuilder) Retryable() *RequestBuilder

+ func (rb *RequestBuilder) Send(ctx context.Context) (*Response, error)

+ func (rb *RequestBuilder) Timeout(timeout time.Duration) *RequestBuilder

+ type RequestHook func(context.Context, *http.Request)

+ type Response struct

+ func (r *Response) Close() error

+ func (r *Response) CopyTo(dst io.Writer) (int64, error)

+ func (r *Response) Debug() string

+ func (r *Response) IsSuccess() bool

+ func (r *Response) Trace() TraceInfo

+ type ResponseHook func(context.Context, *http.Response)

+ type RetryPolicy struct

+ InitialBackoff time.Duration

+ Jitter bool

+ MaxAttempts int

+ MaxBackoff time.Duration

+ RespectRetryAfter bool

+ RetryNetworkErrors bool

+ RetryableStatusCodes []int

+ func StandardRetryPolicy() RetryPolicy

+ type TraceInfo struct

+ ConnIdleTime time.Duration

+ ConnTime time.Duration

+ DNSLookup time.Duration

+ IsConnReused bool

+ IsConnWasIdle bool

+ Method string

+ Path string

+ RemoteAddr string

+ RequestAttempt int

+ ResponseTime time.Duration

+ ServerTime time.Duration

+ StatusCode int

+ TCPConnTime time.Duration

+ TLSHandshake time.Duration

+ TotalTime time.Duration

+ URL string

+ func (t *TraceInfo) Snapshot() TraceInfo

+ func (t *TraceInfo) String() string

+ type Tracer interface

+ Inject func(ctx context.Context, req *http.Request)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL