Express Routes
This is a fork from AlbertoFdzM/express-list-endpoints repository.
Express endpoint parser to retrieve a list of the passed router with the set verbs.
Installation
npm install express-routesExamples of use
Print Routes
const { printRoutes } = require('express-list-endpoints');
const app = require('express')();
app.route('/')
.all(function(req, res) { /* Handle request */ })
.get(function(req, res) { /* Handle request */ })
.post(function(req, res) { /* Handle request */ });
app.route('/about')
.get(function(req, res) { /* Handle request */ });
printRoutes(app);
// It omits the 'all' verbs.
/*
GET /
POST /
GET /about
*/Get Endpoints
const { getEndpoints } = require('express-list-endpoints');
const app = require('express')();
app.route('/')
.all(function(req, res) { /* Handle request */ })
.get(function(req, res) { /* Handle request */ })
.post(function(req, res) { /* Handle request */ });
app.route('/about')
.get(function(req, res) { /* Handle request */ });
console.log(listEndpoints(app));
/* It omits the 'all' verbs.
[{
path: '/',
methods: ['GET', 'POST']
},
{
path: '/about',
methods: ['GET']
}]
*/Arguments
app - Express app or router instance
Your router instance (router) or your app instance (app).
Note: Pay attention that before call this script the router or app must have the endpoints registered due to detect them.
license
MIT