Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 1.37 KB

README.md

File metadata and controls

34 lines (27 loc) · 1.37 KB
Raw

Express Explorer

Autodiscovering route explorer for every Express.js application.

Installation

npm install express-explorer

Usage

const express = require('express');
const explorer = require('express-explorer');
const app = new express();
  
//settings params is optional and these are default values:
const settings = {
  format: 'html'
};
  
app.use('/explorer', explorer(settings));

Settings

  • format: html (default) or json. If param is html you will get the explorer panel otherwise all discovered routes are served as a json. Even if you chose to get the html panel you can require the json format passing the query string ?format=json to the endpoint you chose for the explorer (ex. /explorer?format=json).