req_verbose: Show extra output when request is performed

In r-lib/httr2: Perform HTTP Requests and Process the Responses

Show extra output when request is performed

Description

req_verbose() uses the following prefixes to distinguish between different components of the HTTP requests and responses:

• ⁠* ⁠ informative curl messages

• ⁠->⁠ request headers

• ⁠>>⁠ request body

• ⁠<-⁠ response headers

• ⁠<<⁠ response body

Usage

req_verbose(
  req,
  header_req = TRUE,
  header_resp = TRUE,
  body_req = FALSE,
  body_resp = FALSE,
  info = FALSE,
  redact_headers = TRUE
)

Arguments

req	A httr2 request object.
header_req, header_resp	Show request/response headers?
body_req, body_resp	Should request/response bodies? When the response body is compressed, this will show the number of bytes received in each "chunk".
info	Show informational text from curl? This is mainly useful for debugging https and auth problems, so is disabled by default.
redact_headers	Redact confidential data in the headers? Currently redacts the contents of the Authorization header to prevent you from accidentally leaking credentials when debugging/reprexing.

Value

A modified HTTP request.

See Also

req_perform() which exposes a limited subset of these options through the verbosity argument and with_verbosity() which allows you to control the verbosity of requests deeper within the call stack.

Examples

# Use `req_verbose()` to see the headers that are sent back and forth when
# making a request
resp <- request("https://httr2.r-lib.org") |>
  req_verbose() |>
  req_perform()

# Or use one of the convenient shortcuts:
resp <- request("https://httr2.r-lib.org") |>
  req_perform(verbosity = 1)

r-lib/httr2 documentation built on Nov. 4, 2024, 11:32 p.m.