NAME<\/a> HTTP::Request \u2212 HTTP style request message<\/p>\n version 6.26<\/p>\n require HTTP::Request; and usually used like this:<\/p>\n $ua = LWP::UserAgent\u2212>new; “HTTP::Request” is a class encapsulating HTTP<\/small> style requests, consisting of a request line, some headers, and a content body. Note that the LWP<\/small> library uses HTTP<\/small> style requests even for non-HTTP protocols. Instances of this class are usually passed to the request()<\/b> method of an “LWP::UserAgent” object.<\/p>\n “HTTP::Request” is a subclass of “HTTP::Message” and therefore inherits its methods. The following additional methods are available: Constructs a new “HTTP::Request” object describing a request on the object $uri using method $method. The $method argument must be a string. The $uri argument can be either a string, or a reference to a “URI” object. The optional $header argument should be a reference to an “HTTP::Headers” object or a plain array reference of key\/value pairs. The optional $content argument should be a string of bytes.<\/p>\n $r = HTTP::Request\u2212>parse( $str )<\/p>\n This constructs a new request object by parsing the given string.<\/p>\n $r\u2212>method This is used to get\/set the method attribute. The method should be a short string like ” GET”, “HEAD”, “PUT”, “PATCH”<\/small> or ” POST”.<\/small><\/p>\n $r\u2212>uri This is used to get\/set the uri attribute. The $val can be a reference to a URI<\/small> object or a plain string. If a string is given, then it should be parsable as an absolute URI.<\/small><\/p>\n $r\u2212>header( $field ) This is used to get\/set header values and it is inherited from “HTTP::Headers” via “HTTP::Message”. See HTTP::Headers for details and other similar methods that can be used to access the headers.<\/p>\n $r\u2212>accept_decodable<\/p>\n This will set the “Accept\u2212Encoding” header to the list of encodings that decoded_content()<\/b> can decode.<\/p>\n $r\u2212>content This is used to get\/set the content and it is inherited from the “HTTP::Message” base class. See HTTP::Message for details and other methods that can be used to access the content.<\/p>\n Note that the content should be a string of bytes. Strings in perl can contain characters outside the range of a byte. The “Encode” module can be used to turn such strings into a string of bytes.<\/p>\n $r\u2212>as_string Method returning a textual representation of the request.<\/p>\n Creating requests to be sent with LWP::UserAgent or others can be easy. Here are a few examples.<\/p>\n Simple POST<\/small><\/b> #!\/usr\/bin\/env perl Batch POST<\/small> Request<\/b> #!\/usr\/bin\/env perl HTTP::Headers, HTTP::Message, HTTP::Request::Common, HTTP::Response<\/p>\n
VERSION<\/a>
SYNOPSIS<\/a>
DESCRIPTION<\/a>
EXAMPLES<\/a>
SEE ALSO<\/a>
AUTHOR<\/a>
COPYRIGHT AND LICENSE<\/a> <\/p>\n
\nNAME <\/a> <\/h2>\n
VERSION <\/a> <\/h2>\n
SYNOPSIS <\/a> <\/h2>\n
$request = HTTP::Request\u2212>new(GET => ‘http:\/\/www.example.com\/’);<\/p>\n
$response = $ua\u2212>request($request);<\/p>\nDESCRIPTION <\/a> <\/h2>\n
$r = HTTP::Request\u2212>new( $method, $uri )
$r = HTTP::Request\u2212>new( $method, $uri, $header )
$r = HTTP::Request\u2212>new( $method, $uri, $header, $content )<\/p>\n
$r\u2212>method( $val )<\/p>\n
$r\u2212>uri( $val )<\/p>\n
$r\u2212>header( $field => $value )<\/p>\n
$r\u2212>content( $bytes )<\/p>\n
$r\u2212>as_string( $eol )<\/p>\nEXAMPLES <\/a> <\/h2>\n
Here, we\u2019ll create a simple POST<\/small> request that could be used to send JSON<\/small> data to an endpoint.<\/p>\n
use strict;
use warnings;
use HTTP::Request ();
use JSON::MaybeXS qw(encode_json);
my $url = ‘https:\/\/www.example.com\/api\/user\/123’;
my $header = [‘Content\u2212Type’ => ‘application\/json; charset=UTF\u22128’];
my $data = {foo => ‘bar’, baz => ‘quux’};
my $encoded_data = encode_json($data);
my $r = HTTP::Request\u2212>new(‘POST’, $url, $header, $encoded_data);
# at this point, we could send it via LWP::UserAgent
# my $ua = LWP::UserAgent\u2212>new();
# my $res = $ua\u2212>request($r);<\/p>\n
Some services, like Google, allow multiple requests to be sent in one batch.
use strict;
use warnings;
use HTTP::Request ();
use JSON::MaybeXS qw(encode_json);
my $auth_token = ‘auth_token’;
my $batch_url = ‘https:\/\/www.googleapis.com\/batch’;
my $url = ‘https:\/\/www.googleapis.com\/drive\/v3\/files\/fileId\/permissions?fields=id’;
my $url_no_email = ‘https:\/\/www.googleapis.com\/drive\/v3\/files\/fileId\/permissions?fields=id&sendNotificationEmail=false’;
# generate a JSON post request for one of the batch entries
my $req1 = build_json_request($url, {
emailAddress => ‘example@appsrocks.com’,
role => “writer”,
type => “user”,
});
# generate a JSON post request for one of the batch entries
my $req2 = build_json_request($url_no_email, {
domain => “appsrocks.com”,
role => “reader”,
type => “domain”,
});
# generate a multipart request to send all of the other requests
my $r = HTTP::Request\u2212>new(‘POST’, $batch_url, [
‘Accept\u2212Encoding’ => ‘gzip’,
# if we don’t provide a boundary here, HTTP::Message will generate
# one for us. We could use UUID::uuid() here if we wanted.
‘Content\u2212Type’ => ‘multipart\/mixed; boundary=END_OF_PART’
]);
# add the two POST requests to the main request
$r\u2212>add_part($req1, $req2);
# at this point, we could send it via LWP::UserAgent
# my $ua = LWP::UserAgent\u2212>new();
# my $res = $ua\u2212>request($r);
exit();
sub build_json_request {
my ($url, $href) = @_;
my $header = [‘Authorization’ => “Bearer $auth_token”, ‘Content\u2212Type’ => ‘application\/json; charset=UTF\u22128’];
return HTTP::Request\u2212>new(‘POST’, $url, $header, encode_json($href));
}<\/p>\nSEE ALSO <\/a> <\/h2>\n
AUTHOR <\/a> <\/h2>\n