共用方式為


匯入 OpenAPI 規格

適用於:所有 API 管理層

此文章示範如何匯入位於 https://conferenceapi.azurewebsites.net?format=json 的「OpenAPI 規格」後端 API。 這個後端 API 是由 Microsoft 所提供且裝載於 Azure 上。 本文也會示範如何測試 APIM API。

在本文中,您將學會如何:

  • 使用 Azure 入口網站、Azure CLI 或 Azure PowerShell 匯入 OpenAPI 規格
  • 在 Azure 入口網站中測試 API

注意

API 匯入限制記載於 API 匯入的限制和已知問題中。

必要條件

匯入後端 API

  1. Azure 入口網站中,瀏覽至您的 API 管理執行個體。

  2. 在左側功能表中,選取 [API] > [+ 新增 API]

  3. 在 [從定義建立] 底下,選取 [OpenAPI]

    在入口網站中從 OpenAPI 規格建立 API 的螢幕擷取畫面。

  4. 輸入 API 設定。 您可以在建立期間設定這些值,或稍後前往 [設定] 索引標籤來進行設定。這些設定會在 匯入和發佈您的第一個 API 教學課程中說明。

  5. 選取 建立

在入口網站中測試新的 API

您可以從入口網站直接呼叫作業,以方便管理員檢視和測試 API 的作業。

  1. 選取您在上一個步驟中建立的 API。

  2. 選取 [測試] 索引標籤。

  3. 選取作業。 頁面會顯示查詢參數的欄位和標頭的欄位。

    注意

    在測試主控台中,API 管理會自動填入 Ocp-Apim-Subscription-Key 標頭,並設定內建所有存取訂用帳戶的訂用帳戶金鑰。 此金鑰可讓您存取 API 管理執行個體中的每個 API。 (選擇性) 選取 [HTTP 要求] 旁的「眼睛」圖示以顯示 Ocp-Apim-Subscription-Key 標頭。

  4. 視作業而定,輸入查詢參數值、標頭值或要求本文。 請選取傳送

    測試成功時,後端會以成功的 HTTP 回應碼和某些資料進行回應。

    提示

    根據預設,測試主控台會將要求傳送至 APIM 的 CORS Proxy,此 Proxy 會將要求轉送至 APIM 執行個體,然後 APIM 執行個體又將其轉送至後端。 此 Proxy 使用公用 IP 位址 13.91.254.72,而且只能連線到公用端點。 如果您想要直接從瀏覽器將要求傳送至 APIM 服務,請選取 [略過 CORS Proxy]。 當您想要使用測試主控台,且 APIM 閘道與網路隔離或不允許來自 CORS Proxy 的流量時,請使用此選項。

若要偵錯 API,請參閱教學課程:使用要求追蹤對 API 進行偵錯

附加其他 API

您可撰寫由不同服務所公開 API 的 API,包含:

  • OpenAPI 規格
  • SOAP API
  • GraphQL API
  • 在 Azure App Service 中託管的 Web 應用程式
  • Azure 函數應用程式
  • Azure Logic 應用程式
  • Azure Service Fabric

使用下列步驟,將不同的 API 附加至您現有的 API。

注意

在您匯入另一個 API 後,作業就會附加至目前的 API。

  1. 移至 Azure 入口網站中的 Azure API 管理執行個體。

    前往 Azure API 管理執行個體

  2. [概觀] 頁面上,或從左側功能表,選取 [API]

    選取 API

  3. 在您要附加另一個 API 的 API 旁,按一下 ...

  4. 從下拉式功能表中選取 [匯入]

    選取匯入

  5. 選取要從中匯入 API 的服務。

    選取服務

根據 OpenAPI 規格進行驗證

您可以設定 APIM 驗證原則,以針對 OpenAPI 規格中的架構驗證要求和回應 (或元素)。 例如,使用 validate-content 原則來驗證要求或回應本文的大小或內容。

下一步