req_dry_run {httr2} | R Documentation |
Perform a dry run
Description
This shows you exactly what httr2 will send to the server, without
actually sending anything. It requires the httpuv package because it
works by sending the real HTTP request to a local webserver, thanks to
the magic of curl::curl_echo()
.
Usage
req_dry_run(req, quiet = FALSE, redact_headers = TRUE)
Arguments
req |
A request. |
quiet |
If |
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
Invisibly, a list containing information about the request,
including method
, path
, and headers
.
Examples
# httr2 adds default User-Agent, Accept, and Accept-Encoding headers
request("http://example.com") |> req_dry_run()
# the Authorization header is automatically redacted to avoid leaking
# credentials on the console
req <- request("http://example.com") |> req_auth_basic("user", "password")
req |> req_dry_run()
# if you need to see it, use redact_headers = FALSE
req |> req_dry_run(redact_headers = FALSE)
[Package httr2 version 1.0.2 Index]