express-list-endpoints

Express List Endpoints

Express endpoint parser to retrieve a list of the passed router with the set verbs.

Example of use

const listEndpoints = require('express-list-endpoints')

let app = require('express')();

app.route('/')
  .all(function namedMiddleware(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'],
    middlewares: ['namedMiddleware', 'anonymous', 'anonymous']
  },
  {
    path: '/about',
    methods: ['GET'],
    middlewares: ['anonymous']
}]
*/

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

Changelog

v6.0.0 - 2021-07-29

Deprecated

• BREAKING CHANGE Drop support for NodeJS v10

Fixed

• Fixed a problem when parsing the property middlewares for each endpoint being allocated in middleware property instead

Dev

• Added CI using GitHub Actions
• Update dev dependencies
• Removed TravisCI from the project
• Refactor code to use new JS methods and improve readability