建立 API 閘道

已完成

組織通常需要為夥伴提供資料存取。 此存取必須受到控制及管理。

在鞋業公司範例中,向 NorthWind Shoes 進貨的零售商需要知道他們可以訂購多少庫存。 客戶也想要知道他們能夠取得其訂單的確切時間。

您將在這裡了解 Azure API 管理的運作方式,以及如何設定 API 閘道。

Azure API 管理

Azure API 管理服務裝載於 Azure 雲端,且位於 API 與網際網路之間。 您的 API 管理執行個體可作為 Azure API 閘道。

當您發佈 API 時,會使用 Azure 入口網站來控制如何向取用者公開特定 API。 您可能需要基於示範目的來將某些 API 免費提供給開發人員,並嚴格控制對其他 API 的存取。

為什麼要使用 API 管理?

針對開發人員,API 管理會提供一連串優點。

  • API 文件: API 文件能夠呼叫用戶端,快速整合其解決方案。 API 管理可讓您快速地公開 API 的結構,以透過 Open API 之類的最新標準來呼叫用戶端。 您可以有一個以上的 API 版本。 使用多個版本,您能夠暫存應用程式的更新,因為取用您 API 的應用程式不需立即使用新版本。
  • 速率限制存取: 若您的 API 可能會存取大量資料,建議您限制用戶端可以要求資料的速率。 速率限制有助於維護每個用戶端的最佳回應時間。 API 管理可讓您設定整體速率限制,或針對特定的個別用戶端進行設定。
  • 健康情況監視。 遠端用戶端會取用您的 API,因此很難識別潛在的問題或錯誤。 API 管理可讓您檢視錯誤回應和記錄檔,並依回應類型進行篩選。
  • JSON 之類的新式格式: 多年來,API 已使用過許多不同的資料交換格式,範圍從 XML 到 CSV 及其他更多格式都有。 API 管理可讓您使用 JSON 之類的新式資料模型來公開這些格式。
  • 連線到任何 API: 在許多企業中,API 位於不同的國家或地區且使用不同的格式。 API 管理可讓您將所有這些不同的 API 新增至單一新式介面。
  • 分析。 當您開發 API 時,查看呼叫您 API 的頻率以及由哪些類型的系統呼叫是非常實用的。 「API 管理」可讓您在 Azure 入口網站內將此資料視覺化。
  • 安全性。 處理系統資料時,安全性至關重要。 未經授權的安全性缺口可能導致公司損失金錢、因重寫程式碼而耗費時間,以及聲譽的損失。 您可以與 Azure API 管理搭配使用的安全性工具包括 OAuth 2.0 使用者授權,以及與 Microsoft Entra ID 整合。
  • 定價層。 APIM 會要求輸送量、服務等級協定 (SLA)、網路隔離、升級彈性等,提供不同功能的層級。 當您建立 Azure API 管理閘道時,您可以選擇符合您需求的層級。

API 管理設定

若要設定 API 管理,您可以:

  1. 建立 API 管理閘道。 您為閘道所使用的名稱,在 .azure-api.net 命名空間內必須是全域唯一的。
  2. 向閘道註冊現有的 Web API。 註冊 API 讓 API 可供取用者在 <閘道>.azure-api.net 端點上使用。
  3. 透過閘道呼叫現有的 API。 取用者現在可以在端點 URL 呼叫 API。