rest

Dec 23, 2025

Changes in this version

+ func PathEscape(path string) string

type ClientOpt

+ func REST() ClientOpt

type ReqOpt

+ func HeadersKV(kv ...string) ReqOpt

Dec 3, 2025

Changes in this version

type RestError

+ func (re *RestError) IsPermanent() bool

+ func (re *RestError) IsTransient() bool

Nov 26, 2025

Changes in this version

type ReqOpt

+ func IfMatch(etag ...header.ETag) ReqOpt

+ func IfModifiedSince(t time.Time) ReqOpt

+ func IfNoneMatch(etag ...header.ETag) ReqOpt

Nov 26, 2025

Changes in this version

type Response

+ Type header.ContentType

Nov 26, 2025

Changes in this version

+ type ClientOpt func(RestClient)

+ func AddHeader(key, value string) ClientOpt

+ func SetAuthentication(authenticator authpkg.Authenticator) ClientOpt

+ func SetHttpClient(httpClient httpclient.HttpClient) ClientOpt

+ type ReqOpt func(*http.Request)

+ func Query(query urlpkg.Values) ReqOpt

+ func QueryKV(kv ...string) ReqOpt

+ type Response struct

+ Body *bodypkg.Body

+ Header http.Header

+ Request *http.Request

+ StatusCode int

+ type RestClient interface

+ ClearCookies func()

+ Delete func(ctx context.Context, path string, reqBody any, opts ...ReqOpt) (*Response, error)

+ Get func(ctx context.Context, path string, opts ...ReqOpt) (*Response, error)

+ Head func(ctx context.Context, path string, opts ...ReqOpt) (*Response, error)

+ Post func(ctx context.Context, path string, reqBody any, opts ...ReqOpt) (*Response, error)

+ Put func(ctx context.Context, path string, reqBody any, opts ...ReqOpt) (*Response, error)

+ Request func(ctx context.Context, method, path string, reqBody any, opts ...ReqOpt) (*http.Response, error)

+ func NewClient(uri string, opts ...ClientOpt) RestClient

+ type RestError struct

+ Cause error

+ Code int

+ Request *http.Request

+ Response Body

+ ResponseType header.ContentType

+ func (re *RestError) Error() string

+ func (re *RestError) UnmarshalJSONResponse(value any) error

+ func (re *RestError) Unwrap() error

Nov 25, 2025

Changes in this version

+ var DefaultTransport http.RoundTripper

+ var JsonMarshalToString = func(v any) (string, error)

+ var JsonUnmarshal = func(r io.Reader, output any) error

+ var RESTErrorStringLimit = 250

+ func DefaultClient(timeout time.Duration) httpclient.HttpClient

+ func Headers(headerKeyVals ...string) http.Header

+ func RESTClient(timeout time.Duration) httpclient.HttpClient

+ func SetDefaultTLSConfig(cfg *tls.Config)

+ type Body interface

+ Bytes func() []byte

+ type HttpClient interface

+ Do func(req *http.Request) (*http.Response, error)

+ type RESTError struct

+ Code int

+ Request *http.Request

+ Response Body

+ ResponseType header.ContentType

+ func (re *RESTError) Error() string

+ func (re *RESTError) UnmarshalJSONResponse(value any) error

+ func (re *RESTError) Unwrap() error

+ type RESTRequest struct

+ func Entity(ctx context.Context, url string, input any, contentType string) *RESTRequest

+ func JSON(ctx context.Context, url string, input any) *RESTRequest

+ func Request(ctx context.Context, url string) *RESTRequest

+ func (rr *RESTRequest) Delete(httpClient HttpClient) *RESTResponse

+ func (rr *RESTRequest) Get(httpClient HttpClient) *RESTResponse

+ func (rr *RESTRequest) HTTPRoundTrip(method string, httpClient HttpClient) *RESTResponse

+ func (rr *RESTRequest) Head(httpClient HttpClient) *RESTResponse

+ func (rr *RESTRequest) Patch(httpClient HttpClient) *RESTResponse

+ func (rr *RESTRequest) Post(httpClient HttpClient) *RESTResponse

+ func (rr *RESTRequest) Put(httpClient HttpClient) *RESTResponse

+ func (rr *RESTRequest) Query(query urlpkg.Values) *RESTRequest

+ func (rr *RESTRequest) With(m http.Header) *RESTRequest

+ func (rr *RESTRequest) WithKV(headerKeyVals ...string) *RESTRequest

+ type RESTResponse struct

+ Body io.ReadCloser

+ Err error

+ Req *http.Request

+ Res *http.Response

+ func (rr *RESTResponse) Status() (respHeader http.Header, statusCode int, err error)

+ func (rr *RESTResponse) ToMap() (data map[string]any, statusCode int, err error)

+ func (rr *RESTResponse) Unmarshal(output any) (respHeader http.Header, statusCode int, err error)