request-json

About

Request is a great HTTP client for NodeJS, but if you deal only with JSON, things could be more straightforward. This lib aims to simplify Request usage for JSON only requests.

Install

Add it to your package.json file or run in your project folder:

npm install request-json --save

Build status

How it works

request = require('request-json');
var client = request.createClient('http://localhost:8888/');
 
var data = {
  title: 'my title',
  content: 'my content'
};
client.post('posts/', data, function(err, res, body) {
  return console.log(res.statusCode);
});
 
client.get('posts/', function(err, res, body) {
  return console.log(body.rows[0].title);
});
 
data = {
  title: 'my new title'
};
client.put('posts/123/', data, function(err, res, body) {
  return console.log(res.statusCode);
});
 
client.del('posts/123/', function(err, res, body) {
  return console.log(res.statusCode);
});
 
data = {
  title: 'my patched title'
};
client.patch('posts/123/', data, function(err, res, body) {
  return console.log(res.statusCode);
});

Note: Previously you should call newClient() but now it is renamed to createClient(). You still can use newClient() though it will throw deprecation message.

Extra: files

data = {
  name: "test"
};
client.sendFile('attachments/', './test.png', data, function(err, res, body) {
  if (err) {
    return console.log(err);
  }
});
 
client.saveFile('attachments/test.png', './test-get.png', function(err, res, body) {
  if (err) {
    return console.log(err);
  }
});
 

sendFile can support file path, stream, array of file path and array of streams. Each file is stored with the key 'file + index' (file0, file1, file2...) in the request in case of array. For a single value, it is stored in the field with key 'file'. If you use a stream, it must have a "path" attribute containing its path or filename.

Extra: basic authentication

client.setBasicAuth('john', 'secret');
client.get('private/posts/', function(err, res, body) {
  return console.log(body.rows[0].title);
});
 

Extra: headers manipulation

client.headers['Cookie'] = 'Your cookie';

Extra: promises

client.get('posts/')
  .then(function(result) {
    console.log(result.res.statusCode);
    console.log(result.body); 
  }).catch(err) {
    console.log(err);
  }
});

Who uses it

request-json and request-json-light are downloaded more than 50 000 times each month. Here are the companies which use it for their API clients:

• Cozy Cloud Personal Cloud Solutions
• LeanKit Team Collaboration Solutions
• Forecast Weather Forecasting
• JS Report Reporting Platform
• Clearhead Digital Optimization Agency