現在のバージョン
URL 内のバージョン
バージョン番号はエンドポイントパスに現れます。破壊的変更と非破壊的変更
破壊的変更(コードの更新が必要)
これらの変更はメジャーバージョンアップ時のみ発生します。- エンドポイントの削除
- レスポンスフィールドの削除
- クエリパラメータの削除
- 新しい必須パラメータの追加
- フィールドのデータ型の変更
- フィールドやリソースの名称変更
- レスポンスコードやエラータイプの変更
- 認可スコープの変更
非破壊的変更(追加)
これらはバージョン変更なしにいつでも発生し得ます。- 新しいエンドポイントの追加
- 新しいオプションパラメータの追加
- 新しいレスポンスフィールドの追加
- 新しい OAuth スコープの追加
- エラーメッセージテキストの変更
- プライバシー/セキュリティ上の理由でフィールドを null にする
リリーススケジュール
廃止ポリシー
新しいメジャーバージョンをリリースする際:- 廃止(Deprecation): 以前のバージョンが廃止予定としてマークされる
- サポート期間: 廃止予定のバージョンは定められた期間動作を継続
- 廃止(Retirement): 廃止予定のバージョンが削除される
定義
最新情報の把握
変更に関する通知を受け取りましょう。Changelog
プラットフォームのすべての変更と更新。
Forum Announcements
破壊的変更のお知らせ。
@XDevelopers
プラットフォームのニュースと更新。
Newsletter
月次ダイジェスト。
移行リソース
新しいバージョンがリリースされる際、以下を提供します。- 移行ガイド: 段階的なアップグレード手順
- エンドポイントのマッピング: v1 と v2 の対応
- データ形式の変更: オブジェクトモデルの相違
移行の概要
現在の移行ガイダンス。
エンドポイントマップ
v1 から v2 へのエンドポイントマッピング。
ベストプラクティス
v2 を使用
新規プロジェクトは最新バージョンから始めましょう。
お知らせを監視
changelog とフォーラムの更新を購読しましょう。
変更をテスト
本番更新前に開発環境でテストしましょう。
移行を計画
廃止まで待たずにアップグレードしましょう。