express-courier v0.0.5

Express-Courier

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

Installation

npm:

$ npm install express-courier

Usage

To use express-courier, just add:

require('epress-courier');
...
app.courier(<path of route files>);
...

Then you can write your file under the path_of_route_files.

Go to example folder to view examples.

The directory structure like following:

|--- query.js
|--- team
|     |----- group.v
|             |------- fetch.js
|             |------- group.middleware.js
|             |------- select.js
|
|--- user 
      |--- id.v.js
      |--- user.index.js
      

It may respond to following requests:

GET /query/13
GET /query
GET /user
DEL /user
GET /user/1
DEL /user/2
GET /team/1/fetch
GET /team/3/select/whatever

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.

index.js

If you want to handle the url that matches a directory name, just put a javascript file named .index.js under that folder. See group.index.js user.index.js

middleware.js

If you want to apply a middleware to some url, you can put a javascript flie named .index.js under a folder. See group.middleware.js or add a middleware property to the modeule.exports. See query.js

Running Tests

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.