cvgellhorn / express-dox

A beautiful and simple express API documentation

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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);
    });
});

About

A beautiful and simple express API documentation

License:MIT License


Languages

Language:HTML 59.6%Language:JavaScript 40.4%