API Reference req v#0.8.0-rc.0

The high-level API.

The adapter contract.

Represents an error when unpacking archives fails, returned by the archive decoders. See Req.Decode.

Sets request authentication.

Brotli decoding using :brotli package.

CSV decoding using nimble_csv.

Verifies the response body against the expected checksum.

Represents a checksum mismatch error, returned when the response body does not match the :checksum option. See Req.Checksum.

Decodes response body based on the detected format.

Asks the server to return compressed response.

Represents an error when decompression fails.

Expect that response matches the given status.

Runs the request using Finch.

gzip decoding using :zlib.

Represents an HTTP protocol error.

JSON decoding using Elixir's JSON module.

NDJSON decoding.

Runs the request against a plug instead of over the network.

Follows redirects.

The low-level API and the request struct.

The response struct.

Asynchronous response body.

Retries a request on errors.

Server-sent events decoding using ServerSentEvents.

A collection of built-in steps.

Tar archive decoding using :erl_tar.

Req testing conveniences.

Represents an error when too many redirects occurred, returned by the Req.Redirect step.

Represents an error with the transport used by an HTTP connection.

An exception returned by Req.Expect when response has unexpected status.

ZIP archive decoding using :zip.

Zstandard decoding using :zstd.