探索 API 管理服務

已完成

API 管理會提供核心功能,以透過開發人員參與、商業見解、分析、安全性與保護來確保 API 程式執行成功。 每個 API 都是由一或多個作業所組成,且每個 API 都可以新增至一或多個產品。 為了使用 API,開發人員會訂閱包含該 API 的產品,然後呼叫 API 的作業,但需受限於可能生效的任何使用方式。

API 管理元件

Azure API 管理是由「API 閘道」、「管理平面」和「開發人員入口網站」所組成。 這些元件預設為 Azure 裝載且完全受控。 API 管理可用於容量和功能不同的各個階層

  • API 閘道是可執行下列動作的端點:

    • 接受 API 呼叫,並將其路由傳送到後端
    • 驗證 API 金鑰及其他與要求一同呈現的認證
    • 強制執行使用量配額和速率限制
    • 轉換原則陳述式中指定的要求和回應
    • 快取回應可改善回應延遲,並將後端服務上的負載降到最低
    • 發出監視、報告和疑難排解的記錄、計量和追蹤
  • 管理平面是您設定 API 程式的管理介面。 可用於:

    • 佈建及設定 API 管理服務設定
    • 定義或匯入 API 結構描述
    • 將 API 封裝至產品
    • 設定原則,例如 API 的配額或轉換
    • 從分析取得見解
    • 管理使用者
  • 開發人員入口網站」是自動產生、可完全自訂的網站,其中包含您的 API 文件。 使用開發人員入口網站,開發人員可以:

    • 閱讀 API 文件
    • 透過互動式主控台呼叫 API
    • 建立帳戶並訂閱以取得 API 金鑰
    • 存取其自身使用量分析資料
    • 下載 API 定義
    • 管理 API 金鑰

Products

產品是將 API 呈現給開發人員的方式。 API 管理中的產品有一或多個 API,並已設定標題、描述及使用規定。 產品可以是「開放式」或「受保護」。 受保護的產品必須先訂閱才能使用,而開放式產品無須訂閱就能使用。 訂閱核准是在產品層級設定,且可能需要系統管理員核准或自動核准。

群組

群組可用來管理開發人員對產品的可見度。 API 管理具有下列不可變的系統群組:

  • 系統管理員 - 管理 API 管理服務執行個體,並建立開發人員所使用的 API、作業和產品。 Azure 訂閱管理員是此群組的成員。
  • 開發人員 - 使用 API 建置應用程式的已驗證開發人員入口網站使用者。 開發人員獲授與開發人員入口網站的存取權,並建置呼叫 API 作業的應用程式。
  • 來賓 - 未經驗證的開發人員入口網站使用者。 他們可獲得特定唯讀存取權,例如能夠檢視 API 但無法進行呼叫。

除了這些系統群組之外,系統管理員還可以建立自訂群組,或使用相關聯 Microsoft Entra 租用戶中的外部群組。

開發人員

開發人員代表 API 管理服務執行個體中的使用者帳戶。 開發人員可以由系統管理員建立或受邀加入,也可以從開發人員入口網站註冊。 每個開發人員都是一或多個群組的成員,並可訂閱這些群組有權查看的產品。

原則

原則是陳述式的集合,會因 API 的要求或回應循序執行。 熱門陳述式包括從 XML 轉換成 JSON 的格式轉換,以及限制開發人員來電數目的通話費率限制,還有許多其他原則可供使用。

如果原則不另行指定,則可以在任何 APIM 原則中,使用原則運算式做為屬性值或文字值。 部分原則 (例如控制流程和設定變數原則) 是以原則運算式為基礎。

原則可以套用在不同的範圍,視您的需求而定:全域 (所有 API)、產品、特定 API 或 API 作業。