// NOTE: Advanced use-case, for normal use see 'formData' usage above var r = request.post('http://service.com/upload', function optionalCallback(err, httpResponse, body) {...}) var form = r.form(); form.append('my_field', 'my_value'); form.append('my_buffer', new Buffer([1, 2, 3])); form.append('custom_file', fs.createReadStream(__dirname + '/unicycle.jpg'), {filename: 'unicycle.jpg'});
multipart/related
在一些不同的HTTP实现中，需要在multipart/related的之前、之后或前后同时添加一个newline/CRLF(通过multipart选项)。特别是在.NET WebAPI 4.0中，需要将preambleCRLF设置为true：
request({ method: 'PUT', preambleCRLF: true, postambleCRLF: true, uri: 'http://service.com/upload', multipart: [ { 'content-type': 'application/json', body: JSON.stringify({foo: 'bar', _attachments: {'message.txt': {follows: true, length: 18, 'content_type': 'text/plain' }}}) }, { body: 'I am an attachment' }, { body: fs.createReadStream('image.png') } ], // alternatively pass an object containing additional options multipart: { chunked: false, data: [ { 'content-type': 'application/json', body: JSON.stringify({foo: 'bar', _attachments: {'message.txt': {follows: true, length: 18, 'content_type': 'text/plain' }}}) }, { body: 'I am an attachment' } ] } }, function (error, response, body) { if (error) { return console.error('upload failed:', error); } console.log('Upload successful! Server responded with:', body); })
4. HTTP认证
在一些HTTP请求中，需要对请求对象进行身份验证。Request提供了多种身份验证方式：
request.get('http://some.server.com/').auth('username', 'password', false); // or request.get('http://some.server.com/', { 'auth': { 'user': 'username', 'pass': 'password', 'sendImmediately': false } }); // or request.get('http://some.server.com/').auth(null, null, true, 'bearerToken'); // or request.get('http://some.server.com/', { 'auth': { 'bearer': 'bearerToken' } });
当使用auth选项进，其可包含以下值：
user || username
pass || password
sendImmediately (可选)
bearer (可选)
而对于最终调用的auth(username, password, sendImmediately, bearer)方法来说，sendImmediately默认为true，这会导致一个 basic 或 bearer 认证头会被发送。如果sendImmediately设置为false，request会在收到401状态后尝试使用一个合适的认证头。
注意，也可以基于RFC 1738标准，在URL中添加认证信息。简单的是使用方式是在主机的@符号前添加user:password：
var username = 'username', password = 'password', url = 'http://' + username + ':' + password + '@some.server.com'; request({url: url}, function (error, response, body) { // Do more stuff with 'body' here });
5. 自定义HTTP头
如果需要设置自定义的HTTP请求头，如：User-Agent，可以通过options对象设置。
var request = require('request'); var options = { url: 'https://api.github.com/repos/request/request', headers: { 'User-Agent': 'request' } }; function callback(error, response, body) { if (!error && response.statusCode == 200) { var info = JSON.parse(body); console.log(info.stargazers_count + " Stars"); console.log(info.forks_count + " Forks"); } } request(options, callback);
6. OAuth签名
Request支持OAuth 1.0。其默认使用的签名算法为 HMAC-SHA1：
// OAuth1.0 - 3-legged server side flow (Twitter example) // step 1 var qs = require('querystring') , oauth = { callback: 'http://mysite.com/callback/' , consumer_key: CONSUMER_KEY , consumer_secret: CONSUMER_SECRET } , url = 'https://api.twitter.com/oauth/request_token' ; request.post({url:url, oauth:oauth}, function (e, r, body) { // Ideally, you would take the body in the response // and construct a URL that a user clicks on (like a sign in button). // The verifier is only available in the response after a user has // verified with twitter that they are authorizing your app. // step 2 var req_data = qs.parse(body) var uri = 'https://api.twitter.com/oauth/authenticate' + '?' + qs.stringify({oauth_token: req_data.oauth_token}) // redirect the user to the authorize uri // step 3 // after the user is redirected back to your server var auth_data = qs.parse(body) , oauth = { consumer_key: CONSUMER_KEY , consumer_secret: CONSUMER_SECRET , token: auth_data.oauth_token , token_secret: req_data.oauth_token_secret , verifier: auth_data.oauth_verifier } , url = 'https://api.twitter.com/oauth/access_token' ; request.post({url:url, oauth:oauth}, function (e, r, body) { // ready to make signed requests on behalf of the user var perm_data = qs.parse(body) , oauth = { consumer_key: CONSUMER_KEY , consumer_secret: CONSUMER_SECRET , token: perm_data.oauth_token , token_secret: perm_data.oauth_token_secret } , url = 'https://api.twitter.com/1.1/users/show.json' , qs = { screen_name: perm_data.screen_name , user_id: perm_data.user_id } ; request.get({url:url, oauth:oauth, qs:qs, json:true}, function (e, r, user) { console.log(user) }) }) })
使用RSA-SHA1 签名时，可传入如下一个OAuth对象：
指定signature_method : 'RSA-SHA1'
代替consumer_secret，指定private_key字符串为 PEM format
而使用PLAINTEXT 签名，可传入如下一个OAuth对象：
指定signature_method : 'PLAINTEXT'
7. 代理
如果指定proxy(代理)选项后，所有的请求(及其后的重定向)都会连接到该代理服务器。
如果终端是一个httpsURL，代理会使用CONNECT请求连接到代理服务器。
首先会生成类似如下一个请求：
HTTP/1.1 CONNECT endpoint-server.com:80 Host: proxy-server.com User-Agent: whatever user agent you specify
然后建立一个到endpoint-server(终端服务器)的80端口的TCP连接，并按如下返回响应：
HTTP/1.1 200 OK
默认情况下，当代理使用http进行通讯时，request会简单的生成一个标准的http代理请求。如，会像如下这样生成一个请求：
HTTP/1.1 GET Host: proxy-server.com Other-Headers: all go here request body or whatever
通过proxyHeaderExclusiveList选项可以明确指定一些代理头，默认会按如下方式设置：