匯入並發佈 API

  • 5 分鐘

若要透過 API 閘道使 API 可供使用，您需要匯入並發佈 API。

在鞋業公司範例中，NorthWind Shoes 希望讓所選夥伴能夠查詢存貨與庫存量。

在這裡，您會了解如何將 API 匯入到 Azure API 管理，以及如何將 API 提供給用戶端使用。

API

API 是一種標準化方式，讓組織能夠將特定資料公開給潛在開發人員或夥伴使用。 例如，在上一個練習中，您已建立 API 來共用有關產品與存貨的資訊。

若要使 API 可供使用，可從將 API 匯入到 API 管理開始。 接著，您可以：

  • 在 API 閘道中使用視覺效果工具來充分測試您的 API。
  • 使用原則來管理對您 API 的存取。

API 架構

有各種 API 架構和標準。 API 管理可為您提供數個匯入 API 的選項。

類型 詳細資料
HTTP 您可以匯入含有空白 API 定義的 HTTP API。 接著手動指定所有必要參數。
WebSocket 設定傳遞至後端 WebSocket 服務。
GraphQL 設定傳遞至後端 GraphQL 服務，或匯入 GraphQL 結構描述，並使用自訂欄位解析程式建立綜合 GraphQL API。
OpenAPI Open API 是一項規格，其中記載適用於 RESTful API 的所有端點和作業，以及所有輸入和輸出參數。 OpenAPI 原稱為 Swagger。
WADL Web 應用程式描述語言是以 HTTP 為基礎之 Web 服務的 XML 描述。 比起 WSDL，其格式更簡單且更輕量。
WSDL Web 服務描述語言是任意網路服務的 XML 描述，而不只是 HTTP。

您也可以從數個後端 Azure 資源匯入 API。

類型 詳細資料
邏輯應用程式 邏輯應用程式可用來透過各種資料來源，協調工作流程和整合並進行自動化。
應用程式服務 裝載在 Azure 的應用程式服務內的 API。
函數應用程式 可透過觸發程序呼叫的無伺服器程式碼。
容器應用程式 微服務的無伺服器容器。

匯入 API

有數種方式可將 API 匯入到 Azure API 管理。

使用 Azure 入口網站，依序選取 [API] 和 [+ 新增 API]。 首先，選取您想要匯入的 API 類別。

Screenshot of Azure portal showing API Management service with the APIs section highlighted and selected.

您接著會以 URL 或檔案形式提供連至您 API 規格的連結，以及 API 的名稱。 以下是 OpenAPI 匯入的範例。

Screenshot of create from OpenAPI specification import settings with OpenAPI specification and display name fields highlighted.

Azure 入口網站不是用來匯入和設定大量 API 的最有效率工具。 當您擴大您的 API 管理時，您會需要其他工具 (例如 Azure CLI、Azure Resource Manager 或 Bicep 範本，或 Azure PowerShell)。 例如，Azure PowerShell Cmdlet 可用來部署 API 閘道、定義和設定產品、匯入 API，以及管理使用者與訂用帳戶。

視覺化

您可以使用 API 閘道作為一種方式，用來將如何透過您匯入的 API 處理資料的過程視覺化。 您可以與資料集互動，並透過 API 傳遞參數。

如果您是系統管理員，即可在 Azure 入口網站中將 API 視覺化。

Screenshot of Azure portal API configuration showing a highlighted GET request test on an imported API.

原則

原則提供強大的功能，可透過設定變更 API 的行為。 它們以敘述集合的形式存在，其會因 API 的要求或回應循序執行。

常用的設定包括：

  • 從 XML 轉換成 JSON
  • 呼叫速率限制來限制連入呼叫的數目。
  • 設定輸入和輸出標頭。

您會使用 Azure 入口網站來將不同原則套用至 API。 您可以在 [設計] 索引標籤中檢視原則。

Screenshot of Azure portal showing API configuration for all operations with base policies highlighted for inbound, outbound, and backend sections.

您也可以使用 [設計] 索引標籤來新增原則。

Screenshot of Azure portal showing inbound policy options for API configuration.

Products

一個產品為一個 API 集合。 您可以將 API 指派給一個以上的產品。 例如，您可能希望某個產品 (NorthWindShoesPartners) 向您的夥伴公開兩個 API：

Products NorthWindShoesPartners
API 1 存貨
API 2 規劃

針對您的供應商，您可能只想公開一個 API：

Products NorthWindShoesSuppliers
API 1 存貨
API 2

您會指派原則，讓產品可以有不同的存取規則、使用量配額及使用規定。 因此，如果您想讓夥伴和供應商對您的存貨 API 擁有不同存取權限，請將該 API 指派給兩個不同的產品。

您使用 Azure 入口網站來將 API 與產品產生關聯。

Screenshot of Azure portal showing API Management with products section highlighted.

針對使用量以外的所有定價層，有兩個預設產品: 入門和無限制。 無限制產品是針對生產 API 管理所設計，因為它對於附加的 API 數目沒有任何限制。 您可以視需要建立任意數量的產品。 入門產品的限制為每分鐘呼叫五個 API，而上限為每週進行 100 次 API 呼叫。