Skip to content

Latest commit

 

History

History

makeen-documentation

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

Makeen Documentation

Makeen plugin that documents and showcases all exposed REST endpoints.

Under the hood it uses hapi-swagger and comes preconfigured with security schemes which describe how secured requests should be done and json editor in the UI.

Once launched documentation will be available at http://localhost:3001/documentation

Requirements

  • Node v6 or higher

Installation

npm install makeen-documentation

Because Makeen is a collection of plugins you will need a Hapi.js server to load and run them. To speed things up Makeen is providing the server component in the shape of a boilerplate which you can clone and install.