restpress

restpress

Minimalist REST framework for express.

msg.js

var restpress = require('restpress');
var msg = new restpress('message');

var data = [
    {
	"id" : 1,
	"message" : "Hello, World!"
    },
    {
	"id" : 2,
	"message" : "Good Bye!"
    }
];

msg.list(function(req, res) {
	res.json(data);
});

msg.read(function(req, res) {
	res.json(data[req.params.id - 1]);
});

msg.create(function(req, res) {
  data.push({"id" : data.length, "message" : req.body.message});
  res.json(data[data.length - 1]);
});

msg.update(function(req, res) {
  data[req.params.id - 1].message = req.body.message;
  res.json(data[req.params.id - 1]);
});

module.exports = msg;

Express 3.x app.js

var express = require('express');
var app = express();

app.use(express.bodyParser());

require('msg').app(app);

app.listen(3010);

Express 4.x app.js

var express = require('express');
var app = express();

var bodyParser = require('body-parser');
app.use(bodyParser.json());

require('msg').app(app);

app.listen(3010);

Restify server.js

var restify = require('restify');
var server = restify.createServer();

// To allow training spaces
server.pre(restify.pre.sanitizePath());
server.use(restify.bodyParser());

require('msg').app(server);

server.listen(3010, function() {
  console.log('%s listening at %s', server.name, server.url);
});

Shift your focus from Routes to Resources, while building RESTful API with node express.

In general, express applications are built by providing callbacks to defined routes. But, RESTFul APIs are more about resources and actions on the resources, than about the routes. Restpress brings the two together. Just like connect is to node & express is to connect, restpress enhances express in creating RESTful applications.

Create action oriented, restful resources independently and then inject them to your express application. Add multiple resources to the same express app.

Although, you create your resources independently, restpress is not a http server. It depends on an express application to run and serve the resources.

Examples

Various examples are available under examples folder.

Checkout full-fledged implementation of RESTful API, with Express and MongoDB.

Beyond vanilla RESTful APIs

Most API implementations go well beyond the standard RESTful CRUD actions. Restpress is designed to support these type of actions.

Test

$ npm test

License

MIT