(deprecated: This repository is old. Please see api-blueprint-template)

API Documentation Tool with aglio

An API Documentation tool sample generated by aglio

Stack

Currently using these tools to generate API document:

• aglio
• gulp-aglio
• api-mock
• TODO: dredd

Installation

$ npm install -g gulp
$ npm install

Usage

Basic Usage

Run

$ gulp

Then it generates api docs, runs local server at http://localhost:8080 , and watches file changes in apidocs.

Run mock server

With api-mock.

$ npm install -g api-mock
$ api-mock public/index.md

Demo

You can see published document HERE

Reference(Japanese)

APIドキュメント作成ツールならApiary.ioよりaglioの方が良かった - dackdive's blog