express-courier

let you route your application based on folder structure for express

npm install express-courier
5 downloads in the last week
20 downloads in the last month

Express-Courier

The express-courier module provides ability to seperate routes into different files. It's built on 'express'. You can use it to build your own controllers on express.

Build Status

Installation

npm:

$ npm install express-courier

Usage

To use express-courier, just add:

require('express-courier');
...
app.courier(<path of module apps>);
...

Then you can write your file under the path_of_route_files.

Go to example folder to view examples.

The directory/filename will be the name in the routing path; If you want to use the name like params, just put .v after the name of directory/filename and before the extension.

use a directory as routes

You can use directory tree to organize your routes.

app.courier(__dirname+'/foder');

Then you can put files under '/folder':

// /folder/query/index.js
module.exports = require('express')();

module.exports.get('/:context', function(req, res) {
    res.send('GET /query/'+req.param.context);
});


// /folder/user/index.js
module.exports.courier = function(app) {
    app.get('/all', function(req, res) {
        res.send('GET /user/all');
    });
};

The app will response to:

GET /query/xxx
GET /user/all

In each file, you can use app as normal express application.

use as express-namespace

Just like express-namespace, but which is more powerful as it use the mount feature in express itself(I guess the 'mount' is not imported when express-namespace was created)

app.courier('/forum/:id', function(app){
    app.get('/(view)?', function(req, res){
        res.send('GET forum ' + req.params.id);
    });

    app.get('/edit', function(req, res){
        res.send('GET forum ' + req.params.id + ' edit page');
    });

    app.courier('/thread', function(){
        app.get('/:tid', function(req, res){
            res.send('GET forum ' + req.params.id + ' thread ' + req.params.tid);
        });
    });
});

The app will response to:

GET /forum/12
GET /forum/12/view
GET /forum/12/edit
GET /forum/12/thread/5

Test

First install npm dependencies:

$ npm install

Then run tests:

$ make test

Or

$ npm run test

License

(The MIT License)

Copyright (c) 2013 Villa.Gao <jky239@gmail.com>;

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
npm loves you