Reqhub NPM | npm.io

ReqHubNode

ReqHub middleware for NodeJS projects. Distribute your API using the ReqHub platform in just a few lines! For more information, visit https://reqhub.io.

Installation

ReqHub is available on npm

npm install --save reqhub

or with Yarn

yarn add reqhub

Distributing an API

To distribute an API for clients to consume with API keys, add the following lines to your index.js:

const reqhub = require('reqhub');

const publicKey = 'yourPublicKey';
const privateKey = 'yourPrivateKey';

const reqhubMiddleware = reqhub.middleware.create(publicKey, privateKey);
app.use(reqhubMiddleware);

That's it! 🎉

Full example:

The Express hello-world example modified to work with ReqHub! The only change we made was adding the lines above.

const express = require('express');
const reqhub = require('reqhub');
const app = express();
const port = 3000;

const publicKey = 'yourPublicKey';
const privateKey = 'yourPrivateKey';

const reqhubMiddleware = reqhub.middleware.create(publicKey, privateKey);
app.use(reqhubMiddleware);

app.get('/', (req, res) => {
  res.send('Hello World!');
});

app.listen(port, () => {
  console.log(`Example app listening at http://localhost:${port}`)
});

Identity

You may want to be able to uniquely identify a client.

How it works

Clients consuming your API create a request hash using their own API keys, which the middleware forwards to the platform along with your request hash. If everything matches up on the platform, the request is allowed to continue.

Consuming an API

To consume an API, start by configuring a client:

const reqhub = require('reqhub');

const publicKey = 'yourClientPublicKey';
const privateKey = 'yourClientPrivateKey';

const client = reqhub.apiClient.create(publicKey, privateKey);

Then use it to make requests!

(async () => {
  const response = await client.get('https://example-url/endpoint');
  console.log(response);
})();

Without async:

client.get('https://example-url/endpoint')
  .then((response) => {
    console.log(response);
  });

Per-endpoint configuration

ReqHub can be configured on a per-endpoint basis, like any Express middleware. This is useful if you only want to publish a portion of your API, or if you want to include multiple small APIs in a single server instance to reduce hosting costs.

With a middleware instance like this:

const publicKey = 'yourPublicKey';
const privateKey = 'yourPrivateKey';

const reqhubMiddleware = reqhub.middleware.create(publicKey, privateKey);

Simply add it to an endpoint and you're all set!

app.get('/', reqhubMiddleware, (req, res) => {
  res.send('Hello World!');
});

You can also add it to a group of endpoints that share a common base route:

// All endpoints starting with /example will use ReqHub
app.use('/example', reqhubMiddleware);

app.get('/example/test', (req, res) => {
  res.send('Hello World!');
});

See https://expressjs.com/en/guide/using-middleware.html for more information on using Express middleware.

Contributing

Go for it! If we're missing something or you're running into a problem, either let us know in an issue or send us a pull request. We think we're pretty reasonable 😘