チュートリアル:リビジョンを使用して互換性に影響しない API の変更を安全に行う

適用対象: すべての API Management レベル

開発者が API を使用する場合、最終的には API の呼び出し元を中断することなく、その API に変更を加える必要があります。また、行った変更内容を開発者に知らせると有効です。

Azure API Management では、 リビジョン を使用して、壊れない API 変更を行います。変更を安全にモデル化してテストできます。準備ができたら、リビジョンを最新の状態にし、現在の API を置き換えます。

詳細については、「バージョンとリビジョン」を参照してください。

ヒント

API チームは、ワークスペースでこの機能を使用できます。ワークスペースは、API と独自の API ランタイム環境への分離された管理アクセスを提供します。

このチュートリアルでは、以下の内容を学習します。

新しいリビジョンの追加
リビジョンに互換性に影響しない変更を加える
リビジョンを最新にして変更ログエントリを追加する
開発者ポータルを参照して、変更内容と変更ログを確認します。
API リビジョンにアクセスする

前提条件

Azure API Management の用語について学習します。
次のクイックスタートを完了すること:Azure API Management インスタンスを作成する。
次のチュートリアルを完了すること: 最初の API のインポートと発行。

新しいリビジョンの追加

Azure portal にサインインし、API Management インスタンスに移動します。
左側のメニューの [API] で、[API] を選択します。
API の一覧から Swagger Petstore を選択するか、リビジョンを追加する別の API を選択します。
[リビジョン] タブを選択します。
[+ リビジョンの追加] を選択します。

ヒント

API のコンテキストメニュー ( [...] ) で [リビジョンの追加] を選択することもできます。
新しいリビジョンの用途を覚えておくために、その説明を入力してください。
［作成］ を選択します

これで、新しいリビジョンが作成されました。

Note

元の API はリビジョン 1 のままとなります。これは、別のリビジョンを最新にすることを選択するまで、ユーザーが引き続き呼び出すリビジョンです。

リビジョンに互換性に影響しない変更を加える

API の一覧から Swagger Petstore を選択します。
画面の上部付近にある [デザイン ] を選択します。

デザインタブの上にある リビジョンセレクター には、現在選択されている リビジョン 2 が表示されます。

ヒント

リビジョンセレクターを使用して、作業対象のリビジョンに切り替えます。
[+ Add Operation] (+ 操作の追加) を選択します。
新しい操作を POST に設定し、操作の [表示名]、および [名前]、[URL] を test に設定します。
新しい操作を保存します。

これで、リビジョン 2 への変更が完了しました。
ページの上部付近にあるリビジョンセレクターを使用して、リビジョン 1 に切り替えます。

新しい操作はリビジョン 1 には表示さません。

ページの上部付近にあるメニューから、[ 変更履歴] を選択します。
リビジョン 2 のコンテキストメニュー (...) を開きます。
[これを最新とする] を選択します。
この変更に関するメモを投稿する場合は、 この API の [公開変更ログに投稿] を選択します。開発者が参照できるように、変更内容の説明を入力します。たとえば、「テスト用リビジョン。新しい "test" 操作を追加しました。」と入力します。

これでリビジョン 2 が最新となりました。

Azure CLI の使用を開始するには:

Azure Cloud Shell で Bash 環境を使用します。詳細については、「Azure Cloud Shell の概要」を参照してください。
CLI リファレンスコマンドをローカルで実行する場合、Azure CLI をインストールします。 Windows または macOS で実行している場合は、Docker コンテナーで Azure CLI を実行することを検討してください。詳細については、「Docker コンテナーで Azure CLI を実行する方法」を参照してください。
- ローカルインストールを使用する場合は、az login コマンドを使用して Azure CLI にサインインします。認証プロセスを完了するには、ターミナルに表示される手順に従います。その他のサインインオプションについては、「 Azure CLI を使用した Azure への認証」を参照してください。
- 初回使用時にインストールを求められたら、Azure CLI 拡張機能をインストールします。拡張機能の詳細については、「Azure CLI で拡張機能を使用および管理する」を参照してください。
- az version を実行し、インストールされているバージョンおよび依存ライブラリを検索します。最新バージョンにアップグレードするには、az upgrade を実行します。

リリースを作成および更新するには、次の手順に従います。

az api list コマンドを実行して、API ID を表示します。
```
az apim api list --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --output table
```
次のコマンドで使用する API ID は Name 値です。 API リビジョンは ApiRevision 列にあります。

リリースノートと共にリリースを作成するには、az apim api release create コマンドを実行します。

az apim api release create --resource-group apim-hello-word-resource-group \
    --api-id swagger-petstore --api-revision 2 --service-name apim-hello-world \
    --notes 'Testing revisions. Added new "test" operation.'

リリースしたリビジョンが最新のリビジョンになります。

リリースを表示するには、az apim api release list コマンドを使用します。
```
az apim api release list --resource-group apim-hello-word-resource-group \
    --api-id swagger-petstore --service-name apim-hello-world --output table
```
指定したメモは変更ログに表示されます。これらは前のコマンドの出力で確認できます。
リリースを作成するときに、--notes パラメーターは省略可能です。メモは、az apim api release update コマンドを使用して後で追加または変更できます。
```
az apim api release update --resource-group apim-hello-word-resource-group \
    --api-id swagger-petstore --release-id 00000000000000000000000000000000 \
    --service-name apim-hello-world --notes "Revised notes."
```
リリース ID の Name 列の値を使用します。

リリースを削除するには、az apim api release delete コマンドを実行します。

az apim api release delete --resource-group apim-hello-word-resource-group \
    --api-id swagger-petstore --release-id 00000000000000000000000000000000 
    --service-name apim-hello-world

開発者ポータルを参照して、変更内容と変更ログを確認します。

開発者ポータルを試す場合は、API の変更を確認し、そこでログを変更できます。

Azure portal で、API Management インスタンスに移動します。
左側のメニューの [API] で、[API] を選択します。
上部のメニューから [開発者ポータル] を選択します。
開発者ポータルで、 [API] を選択し、 [Swagger Petstore] を選択します。
新しい test 操作が使用可能となっています。
API 名の近くにある [ログの変更] を選択します。
この一覧に、変更ログエントリが表示されます。

API リビジョンにアクセスする

API の各リビジョンには、特別な形式の URL を使用してアクセスできます。クエリ文字列の前ではなく、対象の API の URL パスの末尾に ;rev={revisionNumber} を追加することで、その API の特定のリビジョンにアクセスします。たとえば、Swagger Petstore API のリビジョン 2 にアクセスするには、次のような URL を使用できます:

https://apim-hello-world.azure-api.net/store/pet/1;rev=2/

API のリビジョンの URL パスは、Azure portal の [リビジョン] タブで確認できます。

ヒント

API パスにを追加する完全な URL に加えて、;rev 文字列のない API パスを使用して、API の "現在" のリビジョンにアクセスできます。;rev={revisionNumber}

まとめ

このチュートリアルでは、次の作業を行う方法を学びました。

新しいリビジョンの追加
リビジョンに互換性に影響しない変更を加える
リビジョンを最新にして変更ログエントリを追加する
開発者ポータルを参照して、変更内容と変更ログを確認します。
API リビジョンにアクセスする

次のステップ

次のチュートリアルに進みます。

API の複数のバージョンを発行する

フィードバック

このページはお役に立ちましたか?

Last updated on 2026-02-06