express-route-builder

Express-Route-Builder

Quickly compile Express.js routes with minimal code.

NOTE: Requires Node.js v6.x

Quick Use

index.js

Setup your Express app as usual. It's a good idea to create a separate module to handle the building of your routes so as to keep your index.js minimal.

const express = require('express');
const app = express();
const routes = require('./routes');

routes.setup(app);

routes.js

Specify the module filenames that will handle each path with the .addRoute() method.

const path = require('path');
const express = require('express');
const ExpressRouteBuilder = require('express-route-builder');

module.exports.setup = function (app) {
  const baseDir = path.join(__dirname, 'controllers/');
  const builder = new ExpressRouteBuilder(express, app, baseDir);

  builder.addRoute('/comments', 'comments');
  builder.addRoute('/users', 'users');
};

controllers/comments.js (etc)

In each of the route modules you should specify functions named after the HTTP methods you want to expose. You can use any of the HTTP methods that Express supports, including:

get, post, put, head, delete, options, trace, copy, lock, mkcol, move, purge, propfind, proppatch, unlock, report, mkactivity, checkout, merge, m-search, notify, subscribe, unsubscribe, patch, search, connect

Note: The function names must be lowercase.

module.exports.get = function (req, res, next) { ... };
module.exports.post = function (req, res, next) { ... };
// ...and so on.

API

new ExpressRouteBuilder(express, app, baseDir = process.cwd());

Creates a new instance of the builder. The base directory is optional and defaults to the current working directory of your app.

.addRoute(path, filename, middleware = []);

Adds a route to your Express app based on the path given; you can specify any path that Express accepts. The filename should be the name of the module which will handle this route, relative to the base path given in the constructor. Also, you can optionally specify an array of middleware functions to use before the route is processed.