https://github.com/fmcarvalho/express-sitemap-html

An express middleware that builds an HTML sitemap dynamically
https://github.com/fmcarvalho/express-sitemap-html

api-explorer express-middleware expressjs index navigation router sitemap

Last synced: 3 months ago
JSON representation

An express middleware that builds an HTML sitemap dynamically

• Host: GitHub
• URL: https://github.com/fmcarvalho/express-sitemap-html
• Owner: fmcarvalho
• License: mit
• Created: 2017-04-21T14:33:21.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T17:44:57.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T21:46:15.476Z (9 months ago)
• Topics: api-explorer, express-middleware, expressjs, index, navigation, router, sitemap
• Language: JavaScript
• Homepage:
• Size: 1.48 MB
• Stars: 8
• Watchers: 1
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# express-sitemap-html

[![Build](https://travis-ci.org/fmcarvalho/express-sitemap-html.svg?branch=master)](https://travis-ci.org/fmcarvalho/express-sitemap-html)

[![Coverage Status](https://coveralls.io/repos/github/fmcarvalho/express-sitemap-html/badge.svg?branch=master)](https://coveralls.io/github/fmcarvalho/express-sitemap-html?branch=master)

[![Version npm](https://img.shields.io/npm/v/express-sitemap-html.svg)](https://www.npmjs.com/package/express-sitemap-html)

An express middleware that builds an HTML sitemap dynamically.

This is **NOT** an alternative to [sitemap.xml](https://en.wikipedia.org/wiki/Site_map),

but an additional feature that helps users (and developers) to find and test

routes of an express application.

## Usage

[express-sitemap-html](https://www.npmjs.com/package/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.

```js

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](https://github.com/fmcarvalho/express-sitemap-html/blob/master/LICENSE)