1.0.0 • Published 8 years ago

bulk-get v1.0.0

Weekly downloads
3
License
ISC
Repository
github
Last release
8 years ago

bulk-get

Build Status

A simple Express.js middleware for getting multiple JSON API resources in one go.

How to use

This middleware assumes that endpoints follow REST API best practices and have wrapper object:

/users

{ "users": [] }

/users/:userId

{ "user": {} }

Example app

const bodyParser = require('body-parser');
const express = require('express');

const app = express();

const bulkGet = require('./index.js');

app.set('json spaces', 4);

app.use(bodyParser.json());

app.get('/', bulkGet, (req, res) => res.send('finished'));

app.get('/users', (req, res) => {
  res.send({ users: [] });
});

app.get('/countries', (req, res) => {
  res.send({ countries: [ { name: 'Netherlands' } ] });
});

app.use((error, req, res, next) => {
	console.log('Error occured!', error);
	res.sendStatus(500);
});

app.listen(3000, () => console.log('Example app listening on port 3000!'));

Example request:

http://10.47.108.225:3000/?users=/users&countries=/countries

{
  "users":[],
  "countries": [
    { "name":"Netherlands" }
  ]
}