yaag-nodejs

under development

Installation

$ npm install yaag-nodejs

Usage

Use with default options

var docGenerator = require('yaag-nodejs');
var app = require('express')();
var bodyParser = require('body-parser');
app.use(bodyParser.urlencoded({
    extended: true
}));
app.use(bodyParser.json());
app.use(docGenerator());

Use with custom options

var docGenerator = require('yaag-nodejs');
var app = require('express')();
app.use(docGenerator());
var bodyParser = require('body-parser');
app.use(bodyParser.urlencoded({
    extended: true
}));
app.use(bodyParser.json());
app.use(docGenerator({
    on: true,
    baseUrls: {
        Production: 'http://yaag-nodejs.com'
    },
    docTitle: 'Yaag API',
    docPath: '/yaagDocs'
}));

Screenshots

API doc generated with default options

API doc generated with custom options

Contributors

• Akshay Kumar (akshaykumar12527@gmail.com)

License

GNU