これまでのAPIドキュメントを変えるMasheryのI/O Docs

作者 Jeevak Kasarkod , 翻訳者 竹中 翔 - (株)ポータルアイランド 投稿日 2011年8月4日

セクション

エンタープライズ・アーキテクチャ,

設計/アーキテクチャ,

デベロップメント

トピック

SOA ,

REST ,

Architecture ,

エンタープライズアーキテクチャ ,

Agile ,

ドキュメンテーション ,

プログラミング

共有 |

原文(投稿日：2011/07/26)へのリンク

2011年7月25日に、MasheryがI/O Docsのリリースをアナウンスした。I/O Docsは最新のAPI管理SaaSプラットフォームであり、開発者がAPIドキュメント中でAPIを実行しながら学習できるようにし、APIの早期採用につなげることを目指している。

InfoQでは、このツールとその機能について、Masheryのプロダクトマネジメントディレクター、Neil Mansilla氏に話をうかがった。

InfoQ:I/O Docsとはどのようなものですか？また、このプロジェクトはどのようなことを目指しているのですか？

Mashery I/O Docsは、開発者がAPIの使い方をより早く、より効果的に学習することを補助する、インタラクティブなドキュメントです。ライブAPIコールにより、静的なサンプルコードとは対照的に、ドキュメントから直接APIを実行してみることができます。I/O Docsを使っていただければ、外見はシンプルかつクリーンでありながら、メソッドやパラメータレベルの詳細が記載されたドキュメントを公開することができます。
我々の調査によれば、APIドキュメントには、メソッド周りの具体性やAPI呼び出しの例が不足していることが多いようです。I/O Docsは、パラメータを含めたメソッドの構造を開発者にわかりやすいように表示します。また、I/O DocsではAPI呼び出しのサンプルを自動生成することもでき、開発者はライブAPIコール機能を使ってその場でサンプルを作成することができます。I/O Docsの目標は、APIプロバイダーにプラットフォームを提供し、開発者の成功を支えていくことです。

プレスリリースによれば、I/O DocsはAPIプロバイダーに次のようなメリットももたらしてくれる。

- クリアなAPIドキュメント、テスト、デバッグ、探索を全て一箇所に集中
- 開発者がAPIを呼び出せるようになるまでの時間を短縮
- より高速なアプリケーション開発
- 技術サポートの削減
- QA担当やテクニカルライターとAPIの変更についてやりとりするための、強力な内部技術サポートチャネルの提供
- ドキュメントが最新バージョンのAPIを反映していることを保障
- クリーンで美しいデザインのAPIドキュメント

InfoQ: このツールはパブリックAPIでも、企業向けのプライベートなAPIでも同じように扱うことができますか？また、RESTful API以外もサポートしていますか？

Mashery I/O Docsはパブリック、プライベート両方のAPIを扱うことができます。 現在はRESTful APIしかサポートしていませんが、できるだけ早くSOAPをサポートするつもりです。また、Mashery I/O Docsは拡張可能であり、非標準プロトコルのサポートも可能です。

InfoQ:例えばJava DocsからI/O Docsへの移行といった、従来のAPIドキュメントからの移行についての技術的な詳細を教えていただけますか？