restana

REST-Ana

Super fast and minimalist web framework for building REST micro-services.

Usage

npm i restana --save

Creating the service instance

Create unsecure HTTP server:

const service = require('restana')();

Passing HTTP server instance:

const https = require('https');
const service = require('restana')({
    server: https.createServer({
        key: keys.serviceKey,
        cert: keys.certificate
    })
});

See examples:

• HTTPS service demo
• HTTP2 service demo

Creating the micro-service interface

const PetsModel = {
    // ... 
};

service.get('/pets/:id', (req, res) => {
    res.send(PetsModel.findOne(req.params.id));
});

service.get('/pets', (req, res) => {
    res.send(PetsModel.find());
});

service.delete('/pets/:id', (req, res) => {
    res.send(PetsModel.destroy(req.params.id));
});

service.post('/pets/:name/:age', (req, res) => {
    res.send(PetsModel.create(req.params));
});

service.patch('/pets/:id', function (req, res) {
    res.send(this.update(req.params.id, JSON.stringify(req.body)));
}, PetsModel); // attaching this context

service.get('/version', function (req, res) {
    res.body = { // optionally you can send the response data in the body property
        version: '1.0.0'
    }
    res.send(); // 200 is the defacult response code
});

Supported HTTP methods:

const methods = ['get', 'delete', 'put', 'patch', 'post', 'put', 'head', 'options'];

Starting the service

service.start(3000).then((server) => {});

Stopping the service

service.close().then(()=> {});

Middleware usage:

const service = require('restana')({});

// custom middleware to attach the X-Response-Time header to the response
service.use((req, res, next) => {
    let now = new Date().getTime();

    res.on('response', data => {
        data.res.setHeader('X-Response-Time', new Date().getTime() - now);
    });

    return next();
});

// the /v1/welcome route handler
service.get('/v1/welcome', (req, res) => {
    res.send('Hello World!');
});

// start the server
service.start();

Third party middlewares support:

Almost all middlewares using the function (req, res, next) signature format should work. With the consideration that they don't use any custom framework feature.

Examples :

• raw-body: https://www.npmjs.com/package/raw-body. See demo: raw-body.js
• express-jwt: https://www.npmjs.com/package/express-jwt. See demo: express-jwt.js
• body-parser: https://www.npmjs.com/package/body-parser. See demo: body-parser.js

Performance comparison

Performance comparison for a basic Hello World! response in cluster mode with 4 processes:

ab -n 10000 -c 1000 http://localhost:3000/v1/welcome

Results:

• restana: ~1300ms
• koa: ~1500ms
• hapi: ~4200ms
• express: ~1800ms
• restify: ~2000ms