REST.IO

Small extendable REST framework for express and mongoose.

$ npm install rest-io --save

• Sub Resource for Sub Documents
• Authenticated Sub Resource for Sub Documents

• Custom Resource declarations
• Automatic resource routing
• Sub resource binding
• Standard CRUD binding
• Bind all resources found in folder
• User Authentication
• User Authorization
• Typescript definitions

Roadmap

• Resource query/searching
• Resource population control via query

• API
• Resource
• AuthorizedResource
• UserResource

It's easy and fast to use rest.io. To start using rest.io see the next few steps:

Install the necessary node modules:

$ npm i rest-io -S

Create a resource:

var resource = require('rest-io');
var Resource = resource.Resource;
var foodResource = new Resource({
    name: 'food',
    model: {
        name: String
    }
});
module.exports = foodResource;

Create an app:

var express = require('express');
var restIO = require('rest-io');
var mongoose = require('mongoose');
var app = express();

// register the express app with rest.io
restIO(app, {
  resources: __dirname + '/resources'
});

mongoose.connect('mongodb://localhost:27017/test');
app.listen(3000, function () {
    console.log('Server has started under port: 3000');
});
module.exports = app;

Start the server:

node app.js

Resource is now available as:

Registers the app with rest-io. This allows rest-io to bind the routings automatically. The bodyParser module will be used to parse the json requests.

Resources are routed automatically with the configuration provided. These configurations are provided to the Resource constructor.