express-find-routes
v1.0.0
Published
List routes for Express 4
Downloads
194
Maintainers
Readme
express-list-routes
List all routes used in Express[3,4,5]
Example App
const express = require('express');
const expressListRoutes = require('express-list-routes');
const app = express();
app.get('/health', fn)
app.use('/admin', router);
router.route('/user')
.post(fn)
.get(fn)
.put(fn);
List all Routes with prefix
expressListRoutes(app, { prefix: '/api/v1' });
// Logs out the following:
// GET /api/v1/health
// POST /api/v1/admin/user
// GET /api/v1/admin/user
// PUT /api/v1/admin/user
Or only log out nested router routes
expressListRoutes(router);
// Logs out the following:
// POST /admin/user
// GET /admin/user
// PUT /admin/user
Installation
npm install express-list-routes
Options
You can pass a second argument to set some options
{
prefix: '', // A prefix for router Path
spacer: 7 // Spacer between router Method and Path
logger: console.info // A custom logger function
}
Migrations
0.1 -> 1.0
The order of the params have changed, and dropped support for freeform text.
BEFORE 0.1<
expressListRoutes({ prefix: '/api/v1' }, 'API:', router);
AFTER 1.0+
expressListRoutes(router, { prefix: '/api/v1' });