Dead simple MVC routing for express
express-controllers adds controller style routing from the model-view-controller paradigm to express using express-resource.
$ npm install express-controllers
var express = require'express'var controllers = require'express-controllers'var app = moduleexports = expresscontrollers;if !requireparentvar server = applisten3000var host = serveraddressaddress;var port = serveraddressport;console.log'Express 4 server listening at ' host port;;
By default, the
app.controllers() method will load any controllers in the directory named
controllers of your application (wherever server.js/app.js is). If you prefer to store your controllers in a different location, simply specify your desired path in the app setting via
app.set('controllers path', '/path/to/controllers/').
To get started simply
require('express-controllers'), and this module will monkey-patch Express, enabling the controller style routing by providing the
A "controller" is simply a module which defines one of more of the supported "actions", listed below:
ressend'forum index';;ressend'new forum';;ressend'create forum';;ressend'show forum ' + reqparamsforum;;ressend'edit forum ' + reqparamsforum;;ressend'update forum ' + reqparamsforum;;ressend'destroy forum ' + reqparamsforum;;
Actions are then mapped as follows (by default), providing
req.params.forum which contains the substring where ":forum" is shown below:
GET /forums -> index GET /forums/new -> new POST /forums -> create GET /forums/:forum -> show GET /forums/:forum/edit -> edit PUT /forums/:forum -> update DELETE /forums/:forum -> destroy
Currently express-controllers (by way of express-resource) supports basic content-negotiation support utilizing extnames or "formats". This can currently be done two ways, first we may define actions as we normally would, and utilize the
req.format property, and respond accordingly. The following would respond to
GET /pets.xml, and
var pets = 'tobi' 'jane' 'loki';switch reqformatcase 'json':ressendpets;break;case 'xml':ressend'<pets>' + petsmapreturn '<pet>' + pet + '</pet>';join'' + '</pets>';break;default:ressend406;;
The following is equivalent, however we separate the logic into several callbacks, each representing a format.
exportsindex =ressendpets;ressend'<pets>' + petsmapreturn '<pet>' + pet + '</pet>';join'' + '</pets>';;
We may also provide a
default format, invoked when either no extension is given, or one that does not match another method is given:
ressend'Unsupported format "' + reqformat + '"' 406;;
The MIT License Copyright (c) 2011-2014 Nicholas Penree <email@example.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.