0.1.0 • Published 8 years ago

express-dox v0.1.0

Weekly downloads
1
License
MIT
Repository
github
Last release
8 years ago

express-dox

A beautiful and simple express API documentation

screenshot

Install

$ npm install express-dox

Usage

var expressDox = require('express-dox');

// Use with express app, a single router or an array of routers
var source = app || router || [router1, router2];

// Register your own API documentation route
app.get('/api-doc', function(req, res) {
    expressDox(source, { title: 'Express API Documentation' }, function(doc) {
        res.status(200).send(doc);
    });
});