express-docu

v1.0.4
record all your routes and generate HTML api documentation

Express API Documentation

This NPM module will record all your routes and produces a HTML api documentation.

Requirements

To use this module you need tests. The recorder will record all requests and responses of your tests. The NPM only works with express 4.x.

Usage

  var expressdocu = require('express-docu');
  app.use(expressdocu.record);
  
  // run your tests and execute
  node node_modules/express-docu/generateDocs.js

TODO:

  • cleanup recorded files
  • cleanup output
  • configureable folders

Example

npm i express-docu

Metadata

  • Unknown
  • Whatever
  • kirrg001
  • released 9/29/2015

Downloads