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

I/O DocsはWebベースのWeb APIドキュメントおよびテスト実行環境を提供するソフトウェア。

I/O Docsはnode.js/JavaScript製のオープンソース・ソフトウェア。最近のWebサイトではWeb APIの提供が当たり前になっている。データを発信するだけでなく、OAuthを使って認証データやデータの更新権限を与えたりもする。


文字が大きめで分かりやすい

そんなWeb APIをどう実行したら良いか、開発者向けのドキュメントは欠かせない。さらにその場で実行できると便利だ。それを可能にするのがI/O Docsだ。

I/O DocsはオンラインのWeb APIドキュメントだ。メソッドの一覧と、その際のHTTPメソッドが一覧で確認できる。各機能についてパラメータ名や種別、説明文も確認できる。ベーシックではあるが、Web APIとして最低限の機能が備わっている。


テスト実行した所

そしてパラメータには自分で値が入力できる。そして各APIの一番上にあるAPIキーなどを入力することで実際にWeb APIをコールしてその結果を確認できるようになっている。結果はレスポンスのヘッダー、ボディーとなっている。正しいコールの方法が分かるのでデバッグにも役立つだろう。


MOONGIFTはこう見る

Web APIの厄介な所は、コールした際がブラックボックスになっているためにエラーが起きた原因が分かりづらいことだ。いわばコンパイルされたDLLのみ提供されていて、コードのどこが間違っているのか(またはDLL自体のバグなのか)分からないことだ。

I/O Docsは正しいコールの方法を明示しているので、自分がやろうとしていることが合っているのか間違っているのかがすぐに分かる。最近はGoogleやFacebookでもこのようにWeb APIを試せる場を用意している。サンプルを載せるだけでなく、このような工夫もWeb API提供側としては必要になっているようだ。

デモ:Live Documentation

mashery/iodocs - GitHub

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2