puremovic/lout

API documentation generator for hapi

##Description lout is a documentation generator for hapi servers, providing a human-readable guide for every endpoint using the route configuration. The module allows full customization of the output.

##Live demo You can find a live demo of lout using the unit tests routes. The routes are of course fake but you can get a grasp of what lout looks like given various inputs.

##Usage

var Hapi = require('hapi');
var server = new Hapi.Server(80);

server.route([{
    your routes...
}]);

server.pack.require('lout', function() {
    server.start();
});

Usage in Hapi 6.x

Hapi 6.x has deprecated pack.require() use pack.register() instead

var Hapi = require('hapi');
var server = new Hapi.Server(80);

server.pack.register({ plugin: require('lout') }, function() {
    server.start();
});

##Parameters The following options are available when registering the plugin:

'engines' - an object where each key is a file extension (e.g. 'html', 'jade'), mapped to the npm module name (string) used for rendering the templates. Default is { html: 'handlebars' }.
'endpoint' - the path where the route will be registered. Default is /docs.
'basePath' - the absolute path to the templates folder. Default is the lout templates folder.
'cssPath' - the absolute path to the css folder. Default is the lout css folder. It must contain a style.css.
'helpersPath' - the absolute path to the helpers folder. Default is the lout helpers folder. This might need to be null if you change the basePath.
'partialsPath' - the absolute path to the partials folder. Default is the lout templates folder. This might need to be null if you change the basePath.
'auth' - the route configuration for authentication. Default is to disable auth.
'indexTemplate' - the name of the template file to contain docs main page. Default is 'index'.
'routeTemplate' - the name of the route template file. Default is 'route'.

Ignoring a route in documentation

If you want a route not to appear in lout's documentation, you have to set lout settings for this specific route to false.

Here is an example snippet of a route configuration :

{
  method: 'GET',
  path: '/myroute',
  config: {
    handler: [...],
    [...]
    plugins: {
      lout: false
    }
  }
}

puremovic / lout

Usage in Hapi 6.x

Ignoring a route in documentation

About