Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including express-list-endpoints with all npm packages installed. Try it out:

var expressListEndpoints = require("express-list-endpoints")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

express-list-endpoints v5.0.0

A express package to list all registered endoints and its verbs

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

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free