httr2 (version 1.0.5)

response: Create a new HTTP response

Description

Generally, you should not need to call this function directly; you'll get a real HTTP response by calling req_perform() and friends. This function is provided primarily for testing, and a place to describe the key components of a response.

response() creates a generic response; response_json() creates a response with a JSON body, automatically adding the correct Content-Type header.

Usage

response(
  status_code = 200,
  url = "https://example.com",
  method = "GET",
  headers = list(),
  body = raw()
)
response_json(
  status_code = 200,
  url = "https://example.com",
  method = "GET",
  headers = list(),
  body = list()
)

Value

An HTTP response: an S3 list with class httr2_response.

Arguments

status_code

HTTP status code. Must be a single integer.

url

URL response came from; might not be the same as the URL in the request if there were any redirects.

method

HTTP method used to retrieve the response.

headers

HTTP headers. Can be supplied as a raw or character vector which will be parsed using the standard rules, or a named list.

body

Response, if any, contained in the response body. For response_json(), a R data structure to serialize to JSON.

Examples

response()
response(404, method = "POST")
response(headers = c("Content-Type: text/html", "Content-Length: 300"))