resty

package module

Go to main page

Versions in this module

v2

v2.12.0

Mar 17, 2024

Changes in this version

type Client

+ func (c *Client) Clone() *Client

v2.11.0

Dec 27, 2023

v2.10.0

Oct 14, 2023 GO-2023-2328

GO-2023-2328: HTTP request body disclosure in github.com/go-resty/resty/v2

Changes in this version

type Response

+ func (r *Response) SetBody(b []byte) *Response

v2.10.0-rc.3

Oct 8, 2023

v2.10.0-rc.2

Oct 8, 2023

v2.10.0-rc.1

Oct 2, 2023

v2.9.1

Oct 1, 2023

v2.9.0

Sep 30, 2023

Changes in this version

+ var ErrRateLimitExceeded = errors.New("rate limit exceeded")

type Client

+ func (c *Client) SetRateLimiter(rl RateLimiter) *Client

+ type RateLimiter interface

+ Allow func() bool

v2.8.0

Sep 18, 2023

Changes in this version

+ var ErrAutoRedirectDisabled = errors.New("auto redirect is disabled")

+ var ErrDigestAlgNotSupported = errors.New("digest: algorithm is not supported")

+ var ErrDigestBadChallenge = errors.New("digest: challenge is bad")

+ var ErrDigestCharset = errors.New("digest: unsupported charset")

+ var ErrDigestNoQop = errors.New("digest: qop must be specified")

+ var ErrDigestQopNotSupported = errors.New("digest: no supported qop in list")

type Client

+ RawPathParams map[string]string

+ RetryResetReaders bool

+ func (c *Client) OnInvalid(h ErrorHook) *Client

+ func (c *Client) OnPanic(h ErrorHook) *Client

+ func (c *Client) OnSuccess(h SuccessHook) *Client

+ func (c *Client) SetDigestAuth(username, password string) *Client

+ func (c *Client) SetJSONMarshaler(marshaler func(v interface{}) ([]byte, error)) *Client

+ func (c *Client) SetJSONUnmarshaler(unmarshaler func(data []byte, v interface{}) error) *Client

+ func (c *Client) SetRawPathParam(param, value string) *Client

+ func (c *Client) SetRawPathParams(params map[string]string) *Client

+ func (c *Client) SetRetryResetReaders(b bool) *Client

+ func (c *Client) SetXMLMarshaler(marshaler func(v interface{}) ([]byte, error)) *Client

+ func (c *Client) SetXMLUnmarshaler(unmarshaler func(data []byte, v interface{}) error) *Client

+ func (c *Client) Transport() (*http.Transport, error)

type Option

+ func ResetMultipartReaders(value bool) Option

type Request

+ Debug bool

+ RawPathParams map[string]string

+ func (r *Request) SetDebug(d bool) *Request

+ func (r *Request) SetDigestAuth(username, password string) *Request

+ func (r *Request) SetLogger(l Logger) *Request

+ func (r *Request) SetRawPathParam(param, value string) *Request

+ func (r *Request) SetRawPathParams(params map[string]string) *Request

+ type SuccessHook func(*Client, *Response)

v2.7.0

Nov 4, 2021

Changes in this version

type Client

+ BaseURL string

+ PathParams map[string]string

+ XMLMarshal func(v interface{}) ([]byte, error)

+ XMLUnmarshal func(data []byte, v interface{}) error

+ func (c *Client) SetBaseURL(url string) *Client

type Request

+ PathParams map[string]string

+ func (r *Request) AddRetryCondition(condition RetryConditionFunc) *Request

+ func (r *Request) SetHeaderMultiValues(headers map[string][]string) *Request

v2.6.0

Apr 9, 2021

Changes in this version

type Client

+ RetryHooks []OnRetryFunc

+ func (c *Client) AddRetryAfterErrorCondition() *Client

+ func (c *Client) AddRetryHook(hook OnRetryFunc) *Client

+ func (c *Client) SetHeaderVerbatim(header, value string) *Client

+ type OnRetryFunc func(*Response, error)

type Option

+ func RetryHooks(hooks []OnRetryFunc) Option

type Request

+ func (r *Request) SetHeaderVerbatim(header, value string) *Request

v2.5.0

Feb 11, 2021

v2.4.0

Jan 11, 2021

Changes in this version

type Client

+ HeaderAuthorizationKey string

+ func (c *Client) OnError(h ErrorHook) *Client

+ func (c *Client) SetPathParam(param, value string) *Client

+ type ErrorHook func(*Request, error)

type Request

+ Attempt int

+ func (r *Request) SetPathParam(param, value string) *Request

+ type ResponseError struct

+ Err error

+ Response *Response

+ func (e *ResponseError) Error() string

+ func (e *ResponseError) Unwrap() error

type TraceInfo

+ RemoteAddr net.Addr

+ RequestAttempt int

v2.3.0

May 21, 2020

Changes in this version

type Client

+ AuthScheme string

+ func (c *Client) SetAuthScheme(scheme string) *Client

+ type PreRequestHook func(*Client, *http.Request) error

type Request

+ AuthScheme string

+ func (r *Request) ForceContentType(contentType string) *Request

+ func (r *Request) SetAuthScheme(scheme string) *Request

+ func (r *Request) SetMultipartFormData(data map[string]string) *Request

+ type RequestLogCallback func(*RequestLog) error

+ type RequestMiddleware func(*Client, *Request) error

type Response

+ func (r *Response) Proto() string

+ type ResponseLogCallback func(*ResponseLog) error

+ type ResponseMiddleware func(*Client, *Response) error

type TraceInfo

+ TCPConnTime time.Duration

v2.3.0-rc.2

May 12, 2020

v2.3.0-rc.1

May 11, 2020

v2.2.0

Feb 24, 2020

Changes in this version

type Client

+ func (c *Client) SetRootCertificateFromString(pemContent string) *Client

type Request

+ func (r *Request) Send() (*Response, error)

v2.1.0

Oct 10, 2019

Changes in this version

type Request

+ Cookies []*http.Cookie

+ func (r *Request) SetCookie(hc *http.Cookie) *Request

+ func (r *Request) SetCookies(rs []*http.Cookie) *Request

v2.0.0

Jul 17, 2019

Changes in this version

+ const MethodDelete

+ const MethodGet

+ const MethodHead

+ const MethodOptions

+ const MethodPatch

+ const MethodPost

+ const MethodPut

+ const Version

+ func Backoff(operation func() (*Response, error), options ...Option) error

+ func DetectContentType(body interface{}) string

+ func IsJSONType(ct string) bool

+ func IsStringEmpty(str string) bool

+ func IsXMLType(ct string) bool

+ func Unmarshalc(c *Client, ct string, b []byte, d interface{}) (err error)

+ type Client struct

+ AllowGetMethodPayload bool

+ Cookies []*http.Cookie

+ Debug bool

+ DisableWarn bool

+ Error reflect.Type

+ FormData url.Values

+ Header http.Header

+ HostURL string

+ JSONMarshal func(v interface{}) ([]byte, error)

+ JSONUnmarshal func(data []byte, v interface{}) error

+ QueryParam url.Values

+ RetryAfter RetryAfterFunc

+ RetryConditions []RetryConditionFunc

+ RetryCount int

+ RetryMaxWaitTime time.Duration

+ RetryWaitTime time.Duration

+ Token string

+ UserInfo *User

+ func New() *Client

+ func NewWithClient(hc *http.Client) *Client

+ func NewWithLocalAddr(localAddr net.Addr) *Client

+ func (c *Client) AddRetryCondition(condition RetryConditionFunc) *Client

+ func (c *Client) DisableTrace() *Client

+ func (c *Client) EnableTrace() *Client

+ func (c *Client) GetClient() *http.Client

+ func (c *Client) IsProxySet() bool

+ func (c *Client) NewRequest() *Request

+ func (c *Client) OnAfterResponse(m func(*Client, *Response) error) *Client

+ func (c *Client) OnBeforeRequest(m func(*Client, *Request) error) *Client

+ func (c *Client) OnRequestLog(rl func(*RequestLog) error) *Client

+ func (c *Client) OnResponseLog(rl func(*ResponseLog) error) *Client

+ func (c *Client) R() *Request

+ func (c *Client) RemoveProxy() *Client

+ func (c *Client) SetAllowGetMethodPayload(a bool) *Client

+ func (c *Client) SetAuthToken(token string) *Client

+ func (c *Client) SetBasicAuth(username, password string) *Client

+ func (c *Client) SetCertificates(certs ...tls.Certificate) *Client

+ func (c *Client) SetCloseConnection(close bool) *Client

+ func (c *Client) SetContentLength(l bool) *Client

+ func (c *Client) SetCookie(hc *http.Cookie) *Client

+ func (c *Client) SetCookieJar(jar http.CookieJar) *Client

+ func (c *Client) SetCookies(cs []*http.Cookie) *Client

+ func (c *Client) SetDebug(d bool) *Client

+ func (c *Client) SetDebugBodyLimit(sl int64) *Client

+ func (c *Client) SetDisableWarn(d bool) *Client

+ func (c *Client) SetDoNotParseResponse(parse bool) *Client

+ func (c *Client) SetError(err interface{}) *Client

+ func (c *Client) SetFormData(data map[string]string) *Client

+ func (c *Client) SetHeader(header, value string) *Client

+ func (c *Client) SetHeaders(headers map[string]string) *Client

+ func (c *Client) SetHostURL(url string) *Client

+ func (c *Client) SetJSONEscapeHTML(b bool) *Client

+ func (c *Client) SetLogger(l Logger) *Client

+ func (c *Client) SetOutputDirectory(dirPath string) *Client

+ func (c *Client) SetPathParams(params map[string]string) *Client

+ func (c *Client) SetPreRequestHook(h func(*Client, *http.Request) error) *Client

+ func (c *Client) SetProxy(proxyURL string) *Client

+ func (c *Client) SetQueryParam(param, value string) *Client

+ func (c *Client) SetQueryParams(params map[string]string) *Client

+ func (c *Client) SetRedirectPolicy(policies ...interface{}) *Client

+ func (c *Client) SetRetryAfter(callback RetryAfterFunc) *Client

+ func (c *Client) SetRetryCount(count int) *Client

+ func (c *Client) SetRetryMaxWaitTime(maxWaitTime time.Duration) *Client

+ func (c *Client) SetRetryWaitTime(waitTime time.Duration) *Client

+ func (c *Client) SetRootCertificate(pemFilePath string) *Client

+ func (c *Client) SetScheme(scheme string) *Client

+ func (c *Client) SetTLSClientConfig(config *tls.Config) *Client

+ func (c *Client) SetTimeout(timeout time.Duration) *Client

+ func (c *Client) SetTransport(transport http.RoundTripper) *Client

+ type File struct

+ Name string

+ ParamName string

+ func (f *File) String() string

+ type Logger interface

+ Debugf func(format string, v ...interface{})

+ Errorf func(format string, v ...interface{})

+ Warnf func(format string, v ...interface{})

+ type MultipartField struct

+ ContentType string

+ FileName string

+ Param string

+ type Option func(*Options)

+ func MaxWaitTime(value time.Duration) Option

+ func Retries(value int) Option

+ func RetryConditions(conditions []RetryConditionFunc) Option

+ func WaitTime(value time.Duration) Option

+ type Options struct

+ type RedirectPolicy interface

+ Apply func(req *http.Request, via []*http.Request) error

+ func DomainCheckRedirectPolicy(hostnames ...string) RedirectPolicy

+ func FlexibleRedirectPolicy(noOfRedirect int) RedirectPolicy

+ func NoRedirectPolicy() RedirectPolicy

+ type RedirectPolicyFunc func(*http.Request, []*http.Request) error

+ func (f RedirectPolicyFunc) Apply(req *http.Request, via []*http.Request) error

+ type Request struct

+ Body interface{}

+ Error interface{}

+ FormData url.Values

+ Header http.Header

+ Method string

+ QueryParam url.Values

+ RawRequest *http.Request

+ Result interface{}

+ SRV *SRVRecord

+ Time time.Time

+ Token string

+ URL string

+ UserInfo *User

+ func (r *Request) Context() context.Context

+ func (r *Request) Delete(url string) (*Response, error)

+ func (r *Request) EnableTrace() *Request

+ func (r *Request) Execute(method, url string) (*Response, error)

+ func (r *Request) ExpectContentType(contentType string) *Request

+ func (r *Request) Get(url string) (*Response, error)

+ func (r *Request) Head(url string) (*Response, error)

+ func (r *Request) Options(url string) (*Response, error)

+ func (r *Request) Patch(url string) (*Response, error)

+ func (r *Request) Post(url string) (*Response, error)

+ func (r *Request) Put(url string) (*Response, error)

+ func (r *Request) SetAuthToken(token string) *Request

+ func (r *Request) SetBasicAuth(username, password string) *Request

+ func (r *Request) SetBody(body interface{}) *Request

+ func (r *Request) SetContentLength(l bool) *Request

+ func (r *Request) SetContext(ctx context.Context) *Request

+ func (r *Request) SetDoNotParseResponse(parse bool) *Request

+ func (r *Request) SetError(err interface{}) *Request

+ func (r *Request) SetFile(param, filePath string) *Request

+ func (r *Request) SetFileReader(param, fileName string, reader io.Reader) *Request

+ func (r *Request) SetFiles(files map[string]string) *Request

+ func (r *Request) SetFormData(data map[string]string) *Request

+ func (r *Request) SetFormDataFromValues(data url.Values) *Request

+ func (r *Request) SetHeader(header, value string) *Request

+ func (r *Request) SetHeaders(headers map[string]string) *Request

+ func (r *Request) SetJSONEscapeHTML(b bool) *Request

+ func (r *Request) SetMultipartField(param, fileName, contentType string, reader io.Reader) *Request

+ func (r *Request) SetMultipartFields(fields ...*MultipartField) *Request

+ func (r *Request) SetOutput(file string) *Request

+ func (r *Request) SetPathParams(params map[string]string) *Request

+ func (r *Request) SetQueryParam(param, value string) *Request

+ func (r *Request) SetQueryParams(params map[string]string) *Request

+ func (r *Request) SetQueryParamsFromValues(params url.Values) *Request

+ func (r *Request) SetQueryString(query string) *Request

+ func (r *Request) SetResult(res interface{}) *Request

+ func (r *Request) SetSRV(srv *SRVRecord) *Request

+ func (r *Request) TraceInfo() TraceInfo

+ type RequestLog struct

+ Body string

+ Header http.Header

+ type Response struct

+ RawResponse *http.Response

+ Request *Request

+ func (r *Response) Body() []byte

+ func (r *Response) Cookies() []*http.Cookie

+ func (r *Response) Error() interface{}

+ func (r *Response) Header() http.Header

+ func (r *Response) IsError() bool

+ func (r *Response) IsSuccess() bool

+ func (r *Response) RawBody() io.ReadCloser

+ func (r *Response) ReceivedAt() time.Time

+ func (r *Response) Result() interface{}

+ func (r *Response) Size() int64

+ func (r *Response) Status() string

+ func (r *Response) StatusCode() int

+ func (r *Response) String() string

+ func (r *Response) Time() time.Duration

+ type ResponseLog struct

+ Body string

+ Header http.Header

+ type RetryAfterFunc func(*Client, *Response) (time.Duration, error)

+ type RetryConditionFunc func(*Response, error) bool

+ type SRVRecord struct

+ Domain string

+ Service string

+ type TraceInfo struct

+ ConnIdleTime time.Duration

+ ConnTime time.Duration

+ DNSLookup time.Duration

+ IsConnReused bool

+ IsConnWasIdle bool

+ ResponseTime time.Duration

+ ServerTime time.Duration

+ TLSHandshake time.Duration

+ TotalTime time.Duration

+ type User struct

+ Password string

+ Username string

v2.0.0-rc.4

Jul 16, 2019

Other modules containing this package

github.com/go-resty/resty

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