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

ApiDoccoはRESTfulなWeb APIのドキュメントを作成できるWebサービスです。

Web APIを使ってWebサービスを作る、またはWebサービスを作ったらWeb APIを提供するというのは当たり前になってきました。その際に必要になるのがドキュメントです。一から作るのは大変ですが、ApiDoccoを使えばある程度手軽に作れるようになりそうです。


トップページです。APIは独自で追加もできます。


APIDoccoのAPIを見ています。RESTfulなメソッドが並んでいます。


GETアクセスの一覧系です。必須パラメータやそのレスポンスが確認できます。


POSTアクセスでも同じように表示されています。


切り替えはスムーズで内容も見やすいです。

ApiDoccoは左側にメソッドの一覧、右側に実行の際のパラメータとレスポンスを記します。その場で実行が出来る訳ではないようですが(将来的にはできるようになる予定です)、APIドキュメントしては十分見やすく、ある程度慣れた人に使い勝手が良さそうです。

ApiDoccoはnode.js/JavaScript製のソフトウェア(ソースコードは公開されていますがライセンスは明記されていません)です。


MOONGIFTはこう見る

現在のWeb APIの流行としてはOAuthまたはRESTfulです。プラットフォーマートして外部の利用者同士をつなぎたい場合はOAuthが良いでしょうが、サービス側とクライアントをスムーズにつなげたいと考えるのであればRESTfulの方が手軽に使えて便利です。

Web APIの難点はサーバ側での処理がブラックボックスになってしまって、エラーが起きた際のその原因がつかみづらいというのがあります。それだけにドキュメントは多ければ多いに越したことはありません。そしてよりメンテナンス(更新)がしやすいドキュメントフォーマットを選択するのが重要です。

ApiDocco

thomasdavis/apidocco

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2