ITエンジニア/デザイナ向けにオープンソースを毎日紹介

igloはGo製のオープンソース・ソフトウェア(MIT License)です。

モバイルアプリやWebアプリケーションなどWeb APIの利用は多くなっています。そこで必要になるのが可読性の高いAPIドキュメントです。これから作成しようと思われている方にはigloをお勧めします。


元々はMarkdown風なドキュメントで、このようなHTMLファイルが生成されます。


レスポンスはクリックすると表示されます。

igloはAPI Blueprintの記法に沿っています。Markdownに似たフォーマットで、テキストファイルとしての可読性も高く、HTMLへ変換した後はさらに表示の制御がされていて必要な部分が追いかけやすくなっています。

どのようなプログラミング言語であってもAPIリファレンスは付き物です。大きなフレームワークや小さなクラスであってもそれは変わらないでしょう。APIドキュメントがないと常にソースを追いかける必要があるのでプログラマーに使ってもらえなくなります。

プログラミング言語ごとに共通のフォーマットが決まっているものですが、Web APIについてはまだまだ標準フォーマットが存在しないように見えます。RESTful以外のフォーマットにも対応しうるフォーマットを生み出すと人気が出るかも知れませんよ。

Real World API

subosito/iglo

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2