使用 Azure API 管理從 HTTP 端點公開無伺服器 API

  • 發行項

Azure Functions 與入口網站中的 Azure API 管理整合，讓您將 HTTP 觸發程序函式端點公開為 REST API。 這些 API 會使用 OpenAPI 定義來描述。 此 JSON (或 YAML) 檔案包含 API 中可用的作業相關資訊。 其中包含應該如何結構化 API 的要求和回應資料的詳細資料。 藉由整合函數應用程式，您可以讓 API 管理產生這些 OpenAPI 定義。

本文說明如何整合函數應用程式與 API 管理。 這項整合適用於以任何支援的語言開發的函數應用程式。 您也可以從 Azure API 管理匯入函數應用程式。

針對 C# 類別庫函式，您也可以使用 Visual Studio 來建立及發佈與 API 管理整合的無伺服器 API。

建立 API 管理執行個體

若要建立連結至您函數應用程式的 API 管理執行個體：

  1. 選取函式應用程式，從左側功能表中選擇 [API 管理]，然後選取 [API 管理] 底下的 [新建]。

    Choose API Management

  2. 使用下表中指定的 API 管理設定：

    設定 建議的值 名描述
    名稱 全域唯一的名稱 系統會根據您的函式應用程式名稱產生名稱。
    訂用帳戶 您的訂用帳戶 這項新資源建立所在的訂用帳戶。
    資源群組 myResourceGroup 與您的函式應用程式相同的資源，系統應該會為您設定。
    地點 服務的位置 請考慮選擇與函數應用程式相同的位置。
    組織名稱 Contoso 用於開發人員入口網站和電子郵件通知的組織名稱。
    管理員電子郵件 您的電子郵件 從 API 管理接收系統通知的電子郵件。
    定價層 耗用 取用量層並非所有區域都能使用。 如需完整的定價詳細資料，請參閱 API 管理定價頁面

    Create new API Management service

  3. 選擇 [匯出] 以建立 API 管理執行個體，這可能需要幾分鐘的時間。

  4. Azure 在建立執行個體後，會啟用頁面上的 [啟用 Application Insights] 選項。 請選取該選項以將記錄傳送至與函數應用程式相同的位置。

匯入函式

建立 API 管理執行個體之後，您就可以匯入 HTTP 觸發的函式端點。 此範例會匯入名為 TurbineRepair 的端點。

  1. 在 [API 管理] 頁面中，選取 [連結 API]。

  2. [匯入 Azure Functions] 隨即開啟，並醒目提示 TurbineRepair 函式。 選擇 [選取] 以繼續。

    Import Azure Functions into API Management

  3. 在 [從函式應用程式建立] 頁面上接受預設值，然後選取 [建立]。

    Create from Function App

    Azure 會建立函式的 API。

下載 OpenAPI 定義

匯入函式之後，您可以從 API 管理執行個體下載 OpenAPI 定義。

  1. 選取頁面頂端的 [下載 OpenAPI 定義]。

    Download OpenAPI definition

  2. 儲存已下載的 JSON 檔案，然後加以開啟。 檢閱定義。

下一步

現在可以在入口網站的 API 管理中精修定義。 您也可以深入了解 API 管理。

在 API 管理中編輯 OpenAPI 定義