Web APIバージョン

Web APIのバージョン

Yahoo!デベロッパーネットワークで公開しているWeb APIは、すべてバージョン番号が振られています。

後方互換性のない変更がある場合は、バージョン違いのURLでWeb APIを新たに公開します。これにより、旧仕様のWeb APIを利用しているアプリケーションが不具合を起こすことを防ぎます。

バージョンの表記方法

バージョンはリクエストURL中に記載されています。

歴史的な理由により、Yahoo!デベロッパーネットワークのWeb APIのURL設計は2パターン存在します。

http://***.yahooapis.jp/**Service/V1/***古くから存在するWeb APIに多い
http://***.yahooapis.jp/v1/****新しいWeb APIに多い

/V1/または/v1/の部分がバージョンを表します。

バージョン番号はWeb APIごとに振られており、例えばあるWeb APIがv4だったからといって、同じサービスの他のWeb APIもv4が公開されているとは限りません。Web APIの最新バージョンについては、各Web APIのドキュメントをご覧ください。

Web APIのライフサイクル

新規リリース

新たなWeb APIをリリースした場合、Yahoo! JAPAN Tech Blogにて告知いたします。バージョンは1から始まります。

仕様変更

後方互換性を保つ仕様変更、例えば「sortパラメーターに指定できる値の種類が増えた」「レスポンスに要素が追加された」などであれば、バージョンは変更せずに更新することがあります。

後方互換性を壊す仕様変更、例えば「リクエストパラメーター名の変更」「レスポンスの要素名変更」「レスポンスのデフォルト形式をXMLからJSONに変更」などを行う場合、バージョンの違う新たなリクエストURLを作成して公開します。この時、古いURLと新しいURLが同時に公開された状態になります。

古いバージョンのWeb APIは移行期間ののち、提供終了とさせていただくことがあります。新たなバージョンが公開されたら、そちらを使うようアプリケーションを修正することをお勧めいたします。

提供終了

様々な理由から、Web APIの提供を終了させていただくことがあります。この場合、提供終了の2か月前までに こちら にて告知を行います。

提供終了したWeb APIへリクエストすると、エラーが返るようになります。