express-routes-catalogue

A simple utility that lists out all registered routes in your express application.

Installation

 npm install -D express-routes-catalogue 

Example

• Terminal Output

• Web Output

1. Terminal Output

const express = require("express");

const routeList = require("express-routes-catalogue");
const app = express();

app.get("/", (req, res) => {
  res.send("Hello World ...");
});

// For terminal output
if (process.env.NODE_ENV === "development") {
  routeList.terminal(app);
}

...

2. Web output

const express = require("express");
const routeList = require("express-routes-catalogue");
const app = express();

app.get("/", (req, res) => {
  res.send("Hello World ...");
});

// For web output
if (process.env.NODE_ENV === "development") {
  routeList.web(
    app,
    "/route-list"
  );
}

...

Now navigation to your-application/route-list, you can see full routes list.

Contribution

1. Fork it!
2. Create your feature branch: git checkout -b feature-name
3. Commit your changes: git commit -am 'Some commit message'
4. Push to the branch: git push origin feature-name
5. Submit a pull request 😉😉

LICENSE

MIT © Vijay