req_body {httr2} | R Documentation |
req_body_file()
sends a local file.
req_body_raw()
sends a string or raw vector.
req_body_json()
sends JSON encoded data.
req_body_form()
sends form encoded data.
req_body_multipart()
creates a multi-part body.
Adding a body to a request will automatically switch the method to POST.
req_body_raw(req, body, type = NULL)
req_body_file(req, path, type = NULL)
req_body_json(req, data, auto_unbox = TRUE, digits = 22, null = "null", ...)
req_body_form(.req, ...)
req_body_multipart(.req, ...)
req, .req |
A request. |
body |
A literal string or raw vector to send as body. |
type |
Content type. For |
path |
Path to file to upload. |
data |
Data to include in body. |
auto_unbox |
Should length-1 vectors be automatically "unboxed" to JSON scalars? |
digits |
How many digits of precision should numbers use in JSON? |
null |
Should |
... |
Name-data pairs used send data in the body. For
For |
A modified HTTP request.
req <- request("http://httpbin.org/post")
# Most APIs expect small amounts of data in either form or json encoded:
req %>%
req_body_form(x = "A simple text string") %>%
req_dry_run()
req %>%
req_body_json(list(x = "A simple text string")) %>%
req_dry_run()
# For total control over the body, send a string or raw vector
req %>%
req_body_raw("A simple text string") %>%
req_dry_run()
# There are two main ways that APIs expect entire files
path <- tempfile()
writeLines(letters[1:6], path)
# You can send a single file as the body:
req %>%
req_body_file(path) %>%
req_dry_run()
# You can send multiple files, or a mix of files and data
# with multipart encoding
req %>%
req_body_multipart(a = curl::form_file(path), b = "some data") %>%
req_dry_run()