Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/john-doherty/express-batch-requests
Express middleware to process batch HTTP requests
https://github.com/john-doherty/express-batch-requests
express http javascript middleware node rest-api
Last synced: about 23 hours ago
JSON representation
Express middleware to process batch HTTP requests
- Host: GitHub
- URL: https://github.com/john-doherty/express-batch-requests
- Owner: john-doherty
- License: isc
- Created: 2018-11-18T11:37:25.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2018-12-17T15:14:44.000Z (almost 6 years ago)
- Last Synced: 2024-11-07T03:48:13.413Z (11 days ago)
- Topics: express, http, javascript, middleware, node, rest-api
- Language: JavaScript
- Homepage:
- Size: 35.2 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# express-batch-requests
[](https://app.shippable.com/projects/5bf18eee3038210700d633d7)
[](https://www.linkedin.com/in/john-i-doherty) [](https://twitter.com/mrJohnDoherty)
A simple way to add HTTP batch request support to your node API using express middleware.
Batching HTTP requests allows client applications to issue multiple HTTP requests to your API using just one HTTP request - reducing network chatter, latency etc. This middleware extracts and executes each request individually, either in parallel or in series, and returns the result of each request as an array item.
## Installation
```bash
npm install --save express-batch-requests
```
## Usage
```js
var express = require('express');
var server = express();
var expressBatchRequests = require('express-batch-requests');
// mount the batch handler middleware
server.post('/batch', expressBatchRequests);
// typical API route 1
server.get('/route1', function (req, res) {
res.send("Hello World");
});
// typical API route 2
server.post('/route2', function (req, res) {
res.json({
fullName: req.body.firstName + ' ' + req.body.lastName
});
});
// start the server
server.listen(8080, function () {
console.log('Web server listening on port 8080');
});
```
## Request
Requests are executed in parallel by default, to execute them in series add `executeInSeries: true`. Likewise, to include the original request object with each result add `includeRequestsInResponse: true` to the request.
To copy HTTP headers from the batch request onto each of the batch request such as **authorization**, add `mergeHeaders` with a string containing a comma separated list of header names _(in lower case)_.
```json
{
"executeInSeries": true,
"includeRequestsInResponse": true,
"mergeHeaders": "authorization, x-requested-by",
"batch": [
{
"url": "/route1",
"method": "GET"
},
{
"url": "/route2",
"method": "POST",
"headers": {
"User-Agent": "space-command"
},
"body": {
"firstName": "Buzz",
"lastName": "Lightyear"
}
}
]
}
```
## Response
```json
[
{
"request": {
"url": "/route1",
"method": "GET"
},
"response": {
"code": 200,
"headers": {
"content-type": "text/plain"
},
"body": "Hello World"
}
},
{
"request": {
"url": "/route2",
"method": "POST",
"headers": {
"User-Agent": "space-command"
},
"body": {
"firstName": "Buzz",
"lastName": "Lightyear"
}
},
"response": {
"code": 200,
"headers": {
"content-type": "application/json"
},
"body": {
"fullName": "Buzz Lightyear"
}
}
}
]
```
## Star the repo
If you find this useful star the repo as it helps me prioritize which bugs to tackle first.
## History
For change-log, check [releases](https://github.com/john-doherty/express-batch-requests/releases).
## License
Licensed under [MIT License](LICENSE) © [John Doherty](http://www.johndoherty.info)