pretty-express-router v0.0.5

pretty-express-router

This package allows to generate express routers with a convenient routing file defining all routes. Allows to attach middlewares at the context and specific route levels.

Installation

npm install pretty-express-router

Usage Example

// app.js:
const expressRouter = require("pretty-express-router");
const express = require("express");
const routes = require("./routes");

// <your> express application:
const app = express();

expressRouter(app, routes);

The expressRouter method generates the proper express routers, and routes.js is defined as follows:

// routes.js:
const front = require('./front');
const categories = require('./categories/index');
const subcat = require('./categories/insubcat/index');

// the following defines all routes
module.exports = {
  'middlewares': [middleware1, middleware2],
  '* /': front.allMethods,            // all HTTP methods resquested to /
  'get *': front.allGet,              // get requests to all paths
  'get /login': {                     // has a middleware specific to the route
    handler: front.login,
    middlewares: [loginMiddleware]
  },
  categories: {                       // defines a context "/categories/"
    'get *': categories.all,          // all get requests to /categories/
    'get /what': categories.what,
    "insubcat": {                     // /categories/insubcat
      "middlewares": [middleware3],
      "get /whatsub": subcat.whatsub
    }
  }
};

testRoutes in this example is:

// front.js:
function allGet(req, res, next) {
  console.log(`all get...`)
  next();
}

function allMethods(req, res, next) {
  console.log(`all methods...`)
  next();
}

function login(req, res, next) {
  res.json({auth: "valid"})
}

module.exports = {
  login,
  allMethods,
  allGet
}

Also notice that middleware1 and middleware2 are middlewares defined in context "/" while middleware3 is a middleware for "/categories/insubcat/". Also, the get /login has a middleware specific to its route (loginMiddleware).

API

expressRouter(appOrRouter, routes)

appOrRouter can be either an express application or express router. routes are the routes definitions, an hash object (see the example, routes.js).

License

ISC