express-routes-map

0.0.1 • Public • Published

EXPRESS-ROUTES-MAP

Module avaiable on npm repository. Simple module that simplifies the creation of REST APIs on Express. The module is designed to help building rest apis, that expose CRUD functionalities on collections of datas.

Exaple

GET /collection ---> retrieve collection of resources
GET /collection/:id ---> retrieve resource with id, from collection

the same philosophy for POST (create) , PUT (update), DELETE (delete)

GETTING STARTED

server.js

var expressmap = require('express-routes-map'),
http = require('http'),
var app = express(),
.....
....
expressmap(app)
  .defineRoutes('/bill', require('./routes/collectionA'))
  .defineRoutes('/users',require('./routes/collectionB'))
  .defineRoutes('/users',require('./routes/collectionC'))
  .map();

The routes have to be build like the follow:

routes/collectionA.js

var item = {
  get : function(req,res){
          ....
    },
    put : function(req,res){
  
    },
    delete : function(req,res){
        }
};

var collection = {
    get : function(req,res){

    },
    post : function(req,res){
    },
    delete : function(req,res){
    }
};

exports.item = item;
exports.collection = collection;

Readme

Keywords

none

Package Sidebar

Install

npm i express-routes-map

Weekly Downloads

1

Version

0.0.1

License

BSD

Last publish

Collaborators

  • flea89