Express Resource Router

Simple and semantic restful resource routing for Express

Installation

npm install --save express-resource-router

Usage

The API is simple - when you require the module, you will be returned the express.Router() function with eight new methods appended:

1. resource - allows for autoloading of the resource being described
2. index - sets up a '/' get route
3. new - sets up a '/new' get route
4. create - sets up a '/' post route
5. show - sets up a '/:id' get route
6. edit - sets up a '/:id/edit' get route
7. update - sets up a '/:id' put route
8. destroy - sets up a '/:id' delete route

// lets assume this is routes/posts.js
var router = require('express-resource-router');

router.resource(function(id, setResource) {
    // the third argument is optional - it sets req.post 
    // in this case, but req.resource is the default
    setResource(null, Post.find(id), 'post'); 
});

router.index(function(req, res) {
    res.render('posts/index', { posts: Post.all() });
});

router.new(function(req, res) {
    res.render('posts/new', { post: new Post() });
});

router.create(function(req, res) {
    var post = Post.create(/* post params */);
    res.redirect(linkTo(post));
});

router.show(function(req, res) {
    // without the third parameter above in router.resource(...), 
    // we would use req.resource
    res.render('posts/show', { post: req.post });
});

router.edit(function(req, res) {
    res.render('posts/edit', { post: req.post });
});

router.update(function(req, res) {
 	req.post.update(/* post params */);
    res.redirect('back');
});

router.destroy(function(req, res) {
    req.post.delete();
    res.redirect('/posts');
});

module.exports = router;

Then in your application file...

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

app.use('/posts', require('./routes/posts'));

And you're good to go.

Contribution

Right now, I need to write tests for this. If you want to, have at it. Fork and PR, baby.