使用 Azure Spring Apps Enterprise 方案將 API 入口網站遷移至 Azure API 管理
注意
基本、標準和企業方案將從 2025 年 3 月中旬開始淘汰，並停用 3 年。 建議您轉換至 Azure Container Apps。 如需詳細資訊，請參閱 Azure Spring Apps 淘汰公告。
標準 耗用量和專用 方案將從 2024 年 9 月 30 日起淘汰，並在六個月後完成關閉。 建議您轉換至 Azure Container Apps。 如需詳細資訊，請參閱 將 Azure Spring Apps 標準取用和專用方案遷移至 Azure Container Apps。
本文適用於： ❎基本/標準 ✅ 企業
本文說明如何將 API 入口網站遷移至 Azure API 管理。
Azure API 管理 提供集中式介面，可讓您直接從瀏覽器檢視 API 定義和測試特定 API 路由。 它也支援單一登錄（SSO），以改善安全性和無縫存取。 使用 Azure Spring Apps 從 API 入口網站移轉至 Azure API 管理 可增強延展性、安全性和與其他 Azure 服務的整合。
必要條件
- 已啟用 API 入口網站的現有 Azure Spring Apps 企業方案實例。
- 現有的 Azure 容器應用程式。 如需詳細資訊，請參閱快速入門：使用 Azure 入口網站部署您的第一個容器應用程式。
建立 API 管理執行個體
使用下列步驟來建立 API 管理 實例：
在 Azure 入口網站 中，搜尋列中的 API 管理。
從結果中選取 [API 管理 服務]，然後選取 [建立]。
請提供下列必要資訊：
- 訂用帳戶：選取您服務的 Azure 訂用帳戶。
- 資源群組：選取現有的資源群組，或選取 [ 新建 ] 以建立新的資源群組。
- 區域：選擇 API 管理 實例的位置或區域。
- 資源名稱：提供 API 管理 實例的全域唯一名稱。
- 組織名稱：指定組織的名稱。
- 系統管理員電子郵件：提供電子郵件地址，用於與 API 管理 實例相關的通知。
根據您的使用案例選擇定價層。 您稍後一律可以升級或變更定價層。
設定選擇性設定，例如監視和虛擬網路設定。
選取 [ 檢閱 + 建立 ] 以檢閱設定並驗證組態。
驗證完成後，請選取 [ 建立]。 部署可能需要30到40分鐘的時間。
部署完成之後，流覽至 [API 管理 服務] 頁面，以檢視新建立的服務。
在 API 管理 匯入公開的 API
在 API 管理 中匯入 API 有兩個選項：手動新增 API 或匯入 API 規格檔案。
手動新增 API
使用下列步驟手動新增 API：
流覽至 Azure 入口網站中的 API 管理 實例。 在 [API] 區段底下，選取 [新增 API]。
在 [ 定義新的 API ] 窗格中，選取 [HTTP ] 選項以手動定義 HTTP API。
提供下列 API 基本 值，然後選取 [建立 ] 以儲存：
- 顯示名稱：提供 API 的名稱。
- 名稱：輸入 API 的唯一識別碼。
- Web 服務 URL：指定容器應用程式的後端 API 基底 URL。
- API URL 後綴：定義此 API 的後綴 -例如 /api/customers-service。
若要建立新的 API 端點，請選取 [新增作業]，然後使用下列步驟：
- 提供一般資訊。 輸入顯示名稱和名稱。
- 提供作業的詳細數據，例如 HTTP 動詞
GET- ，POST等等 - URL、查詢參數、要求和回應。 - 新增所有作業之後，請儲存您的 API。
選取新增的 API 名稱。 您可以在 [ 設計 ] 索引標籤中看到新增的所有作業。
匯入 API 規格檔案
如果您有 API 的 OpenAPI 規格 - Swagger 定義 - ，您可以使用下列步驟直接匯入至 API 管理：
流覽至 Azure 入口網站中的 API 管理 實例。
開啟 [API] 底下的 [API] 區段。
選取 [ 新增 API]。
針對 [ 從定義建立]，選擇 [OpenAPI ] 選項，以建立與 REST API 的標準語言無關介面。
使用下列步驟從 OpenAPI 規格建立 API：
- 如果您有本機 API 規格檔案，請選取 [ 選取檔案 ] 以上傳檔案。 或者，提供OpenAPI規格的可公開存取 URL 。
- 您可以為 API 提供顯示名稱、名稱和 API URL 後綴的值，進一步精簡 API 設定。
- 若要儲存組態，請選取 [ 建立]。
選取新增的 API 名稱。 您可以看到 [設計] 索引標籤上新增的所有作業。
在 API 管理 中試用 API
Azure API 管理 在 Azure 入口網站 內提供內建的測試控制台，讓您不需要外部工具就能輕鬆地與您的 API 互動。 使用下列步驟來測試您的 API：
流覽至 Azure 入口網站中的 API 管理 實例。
在 [ API] 區段底下，從清單中選取您要測試的 API。
選擇運算子。 在 API 的 [概觀] 頁面中，您可以看到可用作業清單（端點）。 選取您要測試的作業。
選取 [測試] 索引標籤，以在 Azure 入口網站 內開啟。
設定要求參數。 根據 API 方法，輸入要求的必要參數，例如路徑參數、查詢參數、標頭或本文。 如果 API 需要
Authorization Token，請務必將它包含在標頭中。傳送要求。 提供要求詳細數據之後，請選取 [ 傳送]。 API 的回應會直接顯示在 Azure 入口網站 中，包括響應碼、回應本文和標頭。
檢查回應。 檢閱回應數據、狀態代碼，以及可能指出 API 或要求問題的任何錯誤訊息。
將單一登錄移轉至 API 管理
如果您在 API 入口網站中啟用單一登入 （SSO），而且想要驗證 API 管理 的要求，請使用下列步驟在 API 管理 中設定身分識別：
在 Azure 入口網站中，移至您的 APIM 執行個體。
流覽至開發人員入口網站>身分識別。
選取 [ 新增 ]，然後選取 [Azure Active Directory]。
填入必要的欄位：
- 用戶端標識碼：已註冊Microsoft Entra ID 應用程式的應用程式或用戶端識別符。
- 客戶端密碼：Microsoft Entra ID 應用程式的秘密。
-
登入租使用者：Microsoft Entra ID 租使用者的域名，例如
yourcompany.onmicrosoft.com -
重新導向 URL：通常是
https://{your-apim-instance}.developer.azure-api.net/signin。
選取 [ 新增 ] 以儲存識別提供者。
您必須將重新導向 URL 新增至Microsoft Entra ID 用戶端應用程式允許的重新導向 URL 清單，再儲存新增的識別提供者。
如需 API 管理 設定的詳細資訊，請參閱 API 管理 檔。