0.0.1 • Published 12 years ago

express-routes-map v0.0.1

Weekly downloads
1
License
-
Repository
github
Last release
12 years ago

EXPRESS-ROUTES-MAP

Module avaiable on npm registry. 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('/collectionA', require('./routes/collectionA'))
  .defineRoutes('/collectionB',require('./routes/collectionB'))
  .defineRoutes('/collectionC',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;

Bitdeli Badge