Azure Spring Apps Enterprise プランを使用して API Portal を Azure API Management に移行する
Note
Basic、Standard、Enterprise プランは、2025 年 3 月中旬以降非推奨になり、廃止期間は 3 年間です。 Azure Container Apps に移行することをお勧めします。 詳細については、「Azure Spring Apps の廃止のお知らせ」を参照してください。
Standard 従量課金と専用プランは、2024 年 9 月 30 日以降に非推奨になり、6 か月後に完全にシャットダウンされます。 Azure Container Apps に移行することをお勧めします。 詳細については、「Azure Spring Apps の Standard 従量課金および専用プランを Azure Container Apps に移行する」を参照してください。
この記事の適用対象: ❎ Basic/Standard ✅ Enterprise
この記事では、API Portal を Azure API Management に移行する方法について説明します。
Azure API Management は、API 定義を表示し、ブラウザーから直接特定の API ルートをテストするための一元化されたインターフェイスを備えています。 また、セキュリティの向上とシームレスなアクセスのためのシングル サインオン (SSO) もサポートしています。 Azure Spring Apps を使用して API Portal から Azure API Management に移行すると、スケーラビリティ、セキュリティ、他の Azure サービスとの統合が強化されます。
前提条件
- API Portal が有効になっている既存の Azure Spring Apps Enterprise プランのインスタンス。
- 既存の Azure Container Apps。 詳細については、クイックスタート: Azure portal を使用して最初のコンテナー アプリをデプロイする を参照してください。
API Management インスタンスの作成
API Management インスタンスを作成するには、次の手順を実行します。
Azure portal の検索バーで API Management を検索します。
結果から [API Management サービス] を選択し、[作成] を選択します。
次の必須情報を指定します。
- [サブスクリプション]: 対象のサービス用の Azure サブスクリプションを選択します。
- [リソース グループ]: 既存のリソース グループを選択するか、[新規作成] を選択して新規作成します。
- [リージョン]: API Management インスタンスの場所またはリージョンを選択します。
- [リソース名]: API Management インスタンスに、グローバルに一意な名前を指定します。
- [組織名]: 組織の名前を指定します。
- [管理者のメール]: API Management インスタンスに関連する通知に使用するメール アドレスを指定します。
ユース ケースに基づいて価格レベルを選択します。 価格レベルは後でいつでもアップグレードまたは変更できます。
監視設定や仮想ネットワーク設定などのオプションの設定を構成します。
[確認 + 作成] を選択して設定を確認し、構成を検証します。
検証が完了したら、[作成] を選択します。 デプロイには、30 分から 40 分かかる場合があります。
デプロイが完了したら、[API Management サービス] ページに移動して、新しく作成されたサービスを表示します。
公開されている API を API Management にインポートする
API Management に API をインポートするには、API を手動で追加するか、API 仕様ファイルをインポートするかの 2 つの選択肢があります。
API を手動で追加する
手動で API を追加するには、以下の手順を実行します。
Azure portal で API Management インスタンスに移動します。 [API] セクションで、[API の追加] を選択します。
[新しい API の定義] ペインで、[HTTP] オプションを選択して HTTP API を手動で定義します。
[API の基本] の次の値を指定し、[作成] を選択して保存します。
- [表示名]: API の名前を指定します。
- [名前]: API の一意識別子を入力します。
- [Web サービス URL]: Container Apps のバックエンド API のベース URL を指定します。
- [API URL サフィックス]: この API のサフィックスを定義します (例: /api/customers-service)。
新しい API エンドポイントを作成するため、[操作の追加] を選択し、次の手順を使用します。
- 一般情報を入力します。 [表示名] と [名前] を入力します。
- 操作の詳細 (HTTP 動詞 ( -
GET、POSTなど)、URL、クエリ パラメーター、要求、応答など) を指定します。 - すべての操作を追加したら、API を保存します。
追加した API の名前を選択します。 追加されたすべての操作は [デザイン] タブで確認できます。
API 仕様ファイルをインポートする
API の OpenAPI 仕様 (Swagger 定義) がある場合は、次の手順を使用して API Management に直接インポートできます。
Azure portal で API Management インスタンスに移動します。
[API] の下にある [API] セクションを開きます。
[API の追加] を選択します。
定義から作成する場合は [OpenAPI] オプションを選択します。これにより、言語に依存しない標準の REST API へのインターフェイスが作成されます。
次の手順を実行して、OpenAPI 仕様から API を作成します。
- ローカル API 仕様ファイルがある場合は、[ファイルの選択] を選択してファイルをアップロードします。 または、OpenAPI 仕様にパブリックにアクセスできる URL を指定します。
- API の [表示名]、[名前]、[API URL サフィックス] の値を指定することで、API の設定をさらに調整できます。
- 構成を保存するため、[作成] を選択します。
追加した API の名前を選択します。 追加されたすべての操作は [デザイン] タブで確認できます。
API Management で API を試す
Azure API Management には、Azure portal 内に組み込みのテスト コンソールが用意されているため、外部ツールの必要なく API を簡単に操作できます。 API をテストするには、次の手順を実行します。
Azure portal で API Management インスタンスに移動します。
[API] セクションで、テストする API を一覧から選択します。
操作を選択します。 API の概要ページには、使用可能な操作 (エンドポイント) の一覧が表示されます。 テストする操作を選択します。
[テスト] タブを選択して、Azure portal 内で開きます。
要求パラメーターを構成します。 API メソッドに応じて、パス パラメーター、クエリ パラメーター、ヘッダー、本文など、要求に必要なパラメーターを入力します。 API に
Authorization Tokenが必要な場合は、必ずヘッダーに含めます。要求を送信します。 要求の詳細を指定したら、[送信] を選択します。 API からの応答は、Azure portal (応答コード、応答本文、ヘッダーなど) に直接表示されます。
応答を調べます。 応答データ、状態コード、API または要求の問題を示している可能性があるエラー メッセージを確認します。
シングル サインオンを API Management に移行する
API Portal でシングル サインオン (SSO) を有効にし、API Management への要求も認証するには、次の手順を使用して API Management で ID を構成します。
Azure portal で API Management インスタンスに移動します。
開発者ポータル>ID の順に移動します。
[追加] を選択してから [Azure Active Directory] を選択します。
必須フィールドに入力します。
- [クライアント ID]: 登録済みの Microsoft Entra ID アプリケーションのアプリケーションまたはクライアント ID。
- [クライアント シークレット]: Microsoft Entra ID アプリケーションのシークレット。
-
[サインイン テナント]: Microsoft Entra ID テナントのドメイン名 (
yourcompany.onmicrosoft.comなど) -
[リダイレクト URL]: 通常は
https://{your-apim-instance}.developer.azure-api.net/signin。
[追加] を選択して ID プロバイダーを保存します。
新しく追加された ID プロバイダーを保存する前に、Microsoft Entra ID クライアント アプリの許可されたリダイレクト URL の一覧にリダイレクト URL を追加する必要があります。
API Management のその他の構成については、API Management のドキュメントを参照してください。