gulp-apidocでRESTful APIドキュメントを生成する。

RESTful API用のドキュメントを生成するapiDoc

このドキュメント生成をgulpで実行するためのgulp-apidocを試してみました。

Install

npm install gulp-apidoc

Usage

gulp = require "gulp"
apidoc = require "gulp-apidoc"

gulp.task "apidoc", () ->
  apidoc.exec
    src: "./src/coffee"
    dest: "./doc/"
    includeFilters: [".*\\.coffee$"]

includeFiltersは使用している言語によって変更します。

これを実行すると、exampleのようなドキュメントが./docディレクトリ下に生成されます。

簡単にドキュメントが生成出来て、HTTPメソッドを表示出来るのが良いですね。

gulpapiDoc