trout routing library for node.js #

Routing should be simple and semantic. Trout has a very easy
way to set up routes and route groupes. It provides different ways of
setting route parameters in order to organize your URLs to explicitly
define RESTful resources and collections. If your URL scheme is not
following REST intentionally, then it still allows simple definitions
of route parameters.

Design considerations for trout ##

$3

Regex is great but to us it should not belong in our URLs.
Trout attempts to be as minimalistic yet semantic and logical as possible.
This should be a good balance.

$3

trout is designed to be tiny and unintrusive so you can use it with
plain Node and it just adds a few attributes to the request object
simplifying development.

Getting Started ##

$3

``
var http = require('http');
var router = require('trout');

router.get('/home/:name', function(req, res) {
res.write("Hello there, " + req.params.name);
res.end();
});

var handler = function(req, res) {
router.pass(req, res);
};

var app = http.createServer(handler);
app.listen(8080);

`

Powerful features ##

$3

You can explicitly define parameters as part of a resource or a collection.
Of course if you get lazy or you don't necessarily need a RESTful approach to your application
you can just normal parameters.

* `/c:[collectionName]` - Accessed by `req.params.collections.[collectionName]`
* `/r:[resourceName]` - Accessed by `req.params.resources.[resourceName]`
* `/:[normalParameter]` - Accessed by `req.params.[resourceName]`




$3

trout allows you to group routes together. In this example, you can add further paths
to urls starting with "/marbles".

trout also supports arbitrary group nesting, so here we can add other routes that pertain to
"/marbles/rare/" such as "price".

`
router.group('/marbles', function() {
router.group('/rare', function() {
router.get('/price/r:marbleName', function(req, res) {
res.write("The price of " + req.params.resources.marbleName + " is one milllion dollars!");
res.end();
});
})

router.get('/r:marbleName', function(req, res) {
res.write("Oooh I really like your " + req.params.resources.marbleName + " marble!");
res.end();
})
});
`

Some Examples to Get You Started ##

trout is designed for powerful semantic RESTful API development. Here's an example.

`
router.put('/home/:name/c:marbles/r:marbleName', function(req, res) {
res.write("Oh hey, " + req.params.name + ". You added a: ");
res.write(req.params.resources.marbleName + " to your " + req.params.collections.marbles + " marbles collection");
res.end();
});
`

Sending a `PUT` request to `http://localhost:8001/home/dude/reds/shinyMarble` returns:

`Oh hey, dude. You added a: shinyMarble to your reds marbles collection``.