express-sitemap-html

express-sitemap-html

An express middleware that builds an HTML sitemap dynamically. This is NOT an alternative to sitemap.xml, but an additional feature that helps users (and developers) to find and test routes of an express application.

Usage

express-sitemap-html offers an easy way to get an up-to-date HTML index with the endpoints of an express application. It renders a snapshot of all paths of your express application, as links to the corresponding pages, which you can easily navigate (such as a table of contents of your application).

Alternatively you may generate a minimalistic Swagger UI with additional capabilities for route parameters inferred from installed express routes.

const express = require('express')
const sitemap = require('express-sitemap-html')

const app = express()
//... configure routes for the app express

// Add a route to the sitemap
app.get('/sitemap', sitemap(app))

// Alternatively auto generate and install a swagger UI for given express app:
sitemap.swagger('Your app name', app) // available at /api-docs

Installation

$ npm install express-sitemap-html

License

MIT