チュートリアル:リビジョンを使用して互換性に影響しない API の変更を安全に行う
適用対象: すべての API Management レベル
API の準備が整って開発者に使用されると、その API の変更が必要になることがありますが、API の呼び出し元を混乱させないように注意する必要もあります。 また、行った変更内容を開発者に知らせると有効です。
変更を安全にモデル化してテストできるように、Azure API Management で "リビジョン" を使用して、互換性に影響しない API の変更を行います。 準備ができたら、リビジョンを最新とし、現在の API を置き換えることができます。
背景については、「バージョンとリビジョン」および「Azure API Management を使用した API のバージョン管理」をご覧ください。
このチュートリアルでは、次の作業を行う方法について説明します。
- 新しいリビジョンの追加
- リビジョンに互換性に影響しない変更を加える
- リビジョンを最新にして変更ログ エントリを追加する
- 開発者ポータルを参照して、変更内容と変更ログを確認します。
前提条件
- Azure API Management の用語について学習します。
- 次のクイック スタートを完了すること:Azure API Management インスタンスを作成する。
- また、次のチュートリアルを完了すること: 最初の API のインポートと発行。
新しいリビジョンの追加
Azure portal にサインインし、API Management インスタンスに移動します。
[API] を選択します。
API の一覧で [Demo Conference API] (または、リビジョンを追加する別の API) を選択します。
[リビジョン] タブを選択します。
[+ リビジョンの追加] を選択します。
ヒント
API のコンテキスト メニュー ( [...] ) で [リビジョンの追加] を選択することもできます。
新しいリビジョンの使用目的を示す説明を入力します。
[作成] を選択します
これで、新しいリビジョンが作成されました。
Note
元の API はリビジョン 1 のままとなります。 別のリビジョンが最新にされない限り、ユーザーはこのリビジョンを呼び出し続けます。
リビジョンに互換性に影響しない変更を加える
API の一覧で [Demo Conference API](デモ会議 API) を選択します。
画面の上部付近の[Design] (デザイン) タブを選択します。
リビジョン セレクター (デザイン タブのすぐ上) に、現在の選択対象としてリビジョン 2 が表示されます。
ヒント
リビジョン セレクターを使用して、作業対象のリビジョンに切り替えます。
[+ Add Operation] (+ 操作の追加) を選択します。
新しい操作を POST に設定し、操作の名前、表示名、および URL を test に設定します。
新しい操作を保存します。
これで、リビジョン 2 への変更が完了しました。 ページの上部付近にあるリビジョン セレクターを使用して、リビジョン 1 に切り替えます。
新しい操作はリビジョン 1 には表示さません。
リビジョンを最新にして変更ログ エントリを追加する
ページの上部付近にあるメニューから [リビジョン] タブを選択します。
リビジョン 2 のコンテキスト メニュー (...) を開きます。
[これを最新とする] を選択します。
この変更に関するメモを投稿する場合は、 [Post to Public Change log for this API](この API のパブリック変更ログを投稿する) チェック ボックスをオンにします。 開発者が参照できるように、変更内容の説明を入力します。たとえば、「テスト用リビジョン。新しい "test" 操作を追加しました。」と入力します。
これでリビジョン 2 が最新となりました。
開発者ポータルを参照して、変更内容と変更ログを確認します。
開発者ポータルを試したことがあれば、そこで API の変更と変更ログを確認できます。
- Azure portal で [API] を選択します。
- 上部のメニューから [開発者ポータル] を選択します。
- 開発者ポータルで、 [API] を選択し、 [Demo Conference API] を選択します。
- 新しい test 操作が使用可能となっています。
- API 名の近くにある [変更ログ] を選択します。
- この一覧に、変更ログ エントリが表示されます。
次のステップ
このチュートリアルでは、以下の内容を学習しました。
- 新しいリビジョンの追加
- リビジョンに互換性に影響しない変更を加える
- リビジョンを最新にして変更ログ エントリを追加する
- 開発者ポータルを参照して、変更内容と変更ログを確認します。
次のチュートリアルに進みます。