1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/req.R
\name{request}
\alias{request}
\title{Create a new HTTP request}
\usage{
request(base_url)
}
\arguments{
\item{base_url}{Base URL for request.}
}
\value{
An HTTP request: an S3 list with class \code{httr2_request}.
}
\description{
There are three steps needed to perform a HTTP request with httr2:
\enumerate{
\item Create a request object with \code{request(url)} (this function).
\item Define its behaviour with \code{req_} functions, e.g.:
\itemize{
\item \code{\link[=req_headers]{req_headers()}} to set header values.
\item \code{\link[=req_url_path]{req_url_path()}} and friends to modify the url.
\item \code{\link[=req_body_json]{req_body_json()}} and friends to add a body.
\item \code{\link[=req_auth_basic]{req_auth_basic()}} to perform basic HTTP authentication.
\item \code{\link[=req_oauth_auth_code]{req_oauth_auth_code()}} to use the OAuth auth code flow.
}
\item Perform the request and fetch the response with \code{\link[=req_perform]{req_perform()}}.
}
}
\examples{
request("http://r-project.org")
}
|
