Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oneofone/dynamic-routes
Dynamic routes for Express.JS
https://github.com/oneofone/dynamic-routes
Last synced: about 5 hours ago
JSON representation
Dynamic routes for Express.JS
- Host: GitHub
- URL: https://github.com/oneofone/dynamic-routes
- Owner: OneOfOne
- License: apache-2.0
- Created: 2013-08-27T19:49:12.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2016-04-29T01:58:52.000Z (over 8 years ago)
- Last Synced: 2024-08-09T10:01:35.023Z (3 months ago)
- Language: JavaScript
- Size: 16.6 KB
- Stars: 4
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dynamic-routes
> A dynamic router / loader for http://expressjs.com/
## Install
``` bash
npm install dynamic-routes --save
```
## Usage
> **DynamicRoutes(app, path_to_routes, [options])**
## Examples :
#### Express.JS Server :
```js
var express = require('express'),
http = require('http'),
path = require('path'),
DynamicRoutes = require('dynamic-routes'),
app = express();
app.set('port', process.env.PORT || 3000);
app.set('views', __dirname + '/views');
app.use(express.logger('dev'));
app.use(bodyParser());
app.use(express.methodOverride());
app.use(express.cookieParser('secrets secrets, we got extra'));
app.use(express.session());
app.use(app.router);
app.use(express.static(path.join(__dirname, 'public')));
if ('development' == app.get('env')) {
app.use(express.errorHandler());
}
DynamicRoutes(app, __dirname + '/routes/');
// or
/*
DynamicRoutes(app, {
src: __dirname + '/routes/',
ignore: [],
pattern: /\.js$/
});
*/
http.createServer(app).listen(app.get('port'), function(){
console.log('Express server listening on port ' + app.get('port'));
});
```
#### Creating compatible routes :
##### Using an object :
```js
//routes/index.js
module.exports = {
priority: 1000, //this is the `/` handler, therefore it should be the last route.
path: '/',
//this function gets passed the express object one time for any extra setup
init: function(app) {
},
//a middleware that is called from any HTTP methods
ALL: function(req, res, next) {
res.send(' - Common Middleware -');
next();
}
//HTTP method specific routes
GET: function(req, res) {
res.end('GET ');
},
POST: function(req, res) {
res.json(req.body);
res.end('POST ');
},
//routes supports GET, HEAD, POST, PUT, DELETE, OPTIONS, TRACE, PATCH method(all uppercase)
};
```
##### Routing multiple middlewares by assigning an array of middlewares :
```js
module.exports = {
priority: 1000,
path: '/',
init: function(app){
}
ALL: [
function(req, res, next){
res.send(' - Common Middleware 1 - ');
next();
},
function(req, res, next){
res.send(' - Common Middleware 2 - ');
next();
}
],
GET: [
function(req, res, next){
res.send(' GET 1 ');
next();
},
function(req, res){
res.end('end of GET');
}
],
POST: [
function(req, res){
res.json(req.body);
res.end('end of POST');
}
]
/* an array with single route, that is equivalent to
POST: function(req, res){
res.json(req.body);
res.end('end of POST');
}
*/
}
```
##### Using a function :
```js
var user = module.exports = function(app) {
"use strict";
//other setup
app.get(function(req, res) {
res.json({'user': [req.params.id, req.params, req.query, req.body]});
});
};
user.priority = 1;
user.path = '/user/:id?';
```
##### This is equivalent to :
```js
module.exports = {
path: '/user/:id?',
priority: 1,
init: function (app) {
//setup db
},
GET: function(req, res) {
res.json({'user': [req.params.id, req.params, req.query, req.body]});
}
}
```
## Notes
- As of Express 4.x, it's recommended to use `require('body-parser')()` instead of `express.bodyParser()`, check [`this`](http://stackoverflow.com/questions/5710358/how-to-get-post-query-in-express-node-js/20132867#20132867).