lucy-console - SwaggerベースのWeb APIドキュメントサーバ
GoogleやMicrosoft、ApigeeなどWeb APIを活用している各社が集まって設立されたのがOpen API Initiativeです。そのドキュメンテーションのベースになっているのがSwaggerです。 Swaggerを使うとWeb上で実際に試せるWeb APIドキュメントが生成できます。そんなSwaggerドキュメントを扱うのに適したソフトウェアがlucy-consoleです。
lucy-consoleの使い方
lucy-consoleでHacker News APIについて見ているところです。左側によびだせるメソッドが一覧されています。
詳細です。実際に呼び出すこともできます。
サンプルコードもあります。
lucy-consoleを使うことでSwaggerベースのドキュメントが使いやすく公開できるようになります。今後、SwaggerがWeb APIドキュメントの標準になっていくのは間違いないので、なるべくドキュメントはこのフォーマットで作っておくのがいいでしょう。
lucy-consoleはnode/JavaScript製のオープンソース・ソフトウェア(GNU Affero General Public License)です。
API Gallery lucybot/lucy-console: An API console for Swagger 2.0 in NodeJS