APIを作った際にはAPIドキュメントを必ず書かなくてはならない。 API blueprintでさくっと書くのがおすすめ。
デモ
https://tic40.github.io/api-blueprint/public/v1.html
ソースコード
書き方
まずAPI blueprint 記法でAPIドキュメントを書く。 API blueprintはMarkdownを拡張したものなので、基本的にMarkdownの記法が使える。敷居は高くない。
実際にデモ用に書いたソースファイルはこんな感じ
https://raw.githubusercontent.com/tic40/api-blueprint/master/blueprints/v1/apis/tests.md
これだとただのMarkdownで読みにくいので、aglioというレンダーを使って、綺麗なhtmlに書き出そう。
最後に書き出されたhtmlをWebで共有しておしまい。 業務でExcel管理だったのをこの形式に変えてから、結構評判は良い。
