Web APIバージョン
Yahoo! JAPAN Web APIにおける、バージョンの変更・管理についてご説明します。
なぜバージョンがあるのか
ページからHTMLを取得するのではなく、Web APIを利用すると、コンテンツを常に同じ構造で取得できるという利点があります。その構造はXMLスキーマによって記述されます。
しかし、Web APIは新しい機能を追加するために、Web APIの仕様を変更する場合があります。その際に、リクエスト時の変数や出力の構造が変更されると、Web APIを利用したアプリケーションは機能しなくなってしまいます。それを防ぐため、Web APIをバージョン別に管理します。
バージョンはどう作用するか
Yahoo! JAPAN Web APIは、いくつかのバージョンをもっています。各APIリリース時に、バージョン番号が付けられます。ただし、特定のWeb APIのバージョンの入力と出力の構造は変更されません。
ここでは画像検索Web APIを例にして説明します。詳細は、「画像検索」のドキュメントをご覧ください。
リクエストURLにバージョンが指定されています。
http://search.yahooapis.jp/ImageSearchService/V1/imageSearch
画像検索Web APIに新しい機能を追加することが決まると、新しいバージョン（V2）を作成します。そしてそのバージョンが指定されたURLで、新しい機能を提供します。古いバージョン（V1）のURLは、停止のお知らせがあるまで提供を継続します。それによって、 V1のAPIを利用する多くの既存のアプリケーションも変わらず動作を続けます。
各Web APIはそれぞれにバージョンが更新されます。たとえば画像検索Web APIがV2のときに、動画検索Web APIがすでにV5になっていることもあるでしょう。新しいYahoo! JANPANのWeb APIのバージョンについては開発者コミュニティでお知らせします。また、各Web APIのページで最新バージョンを確認できます。
古いバージョンを停止する場合、停止する2か月前までに、開発者コミュニティでお知らせします。停止されたバージョンを呼び出したアプリケーションは、エラーメッセージを受け取ることになります。