express-get-endpoints

4.0.2 • Public • Published

Express List Endpoints

Build Status codecov.io Maintainability

NPM

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(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

Dependencies (0)

    Dev Dependencies (10)

    Package Sidebar

    Install

    npm i express-get-endpoints

    Weekly Downloads

    39

    Version

    4.0.2

    License

    MIT

    Unpacked Size

    9.68 kB

    Total Files

    5

    Last publish

    Collaborators

    • emir.herrera