Azure API 中心 - 重要概念
本文說明 Azure API 中心的重要概念。 Azure API 中心可讓您在集中式位置追蹤 API,以進行探索、重複使用和治理。
資料模型
下圖顯示 Azure API 中心的主要實體,以及它們彼此關聯的方式。 如需這些實體和相關概念的詳細資訊,請參閱下列各節。
API
API 中心的最上層邏輯實體,Azure API 代表您想要追蹤的任何真實世界 API。API 中心可以包含任何類型的 API,包括 REST、GraphQL、gRPC、SOAP、WebSocket 和 Webhook。
庫存中的 API 可以由任何 API 管理解決方案管理,如 Azure API 管理、Apigee API 管理、Kong Konnect、MuleSoft API 管理或其他平台。 Azure API 中心中表示的 API 也可以是非受控的。
Azure API 中心的 API 庫存旨在由 API 程式管理員或 IT 管理員建立和管理。 Azure API 中心也包含 API 開發人員直接從其開發環境註冊 API 定義的功能,例如 Visual Studio Code 或 CI/CD 管線。
API 版本
API 版本控制是管理 API 變更,並確保這些變更在不中斷客戶端的情況下進行的做法。 API 在不同生命週期階段可有多個版本,每個版本都與特定的 API 變更保持一致。 某些版本可能引入重大變更,而其他版本則新增次要改善。 API 版本可位於任何生命週期階段 – 設計、預覽、生產或已淘汰。
API 定義
每個 API 版本最好是由至少一項定義所定義,例如適用於 REST API 的 OpenAPI 定義。 Azure API 中心允許任何 API 定義檔案格式化為文字 (YAML、JSON、Markdown 等等)。 您可以上傳 OpenAPI、gRPC、GraphQL、AsyncAPI、WSDL 和 WADL 定義等。
為了協助進行 API 治理,Azure API 中心提供 Linting 功能來分析 API 定義,以符合組織標準的品質和合規性。
Environment
環境代表可以部署 API 執行階段的位置,例如 Azure API 管理服務、Apigee API 管理服務,或 Kubernetes 叢集、Web 應用程式或 Azure 函式等計算服務。 每個環境都與一個開發、測試、預備或生產之類的生命週期階段對應。 環境還可以包括關於開發人員入口網站或管理介面的資訊。
注意
使用 Azure API 中心來追蹤任何 API 執行階段環境,不論它們是否裝載在 Azure 基礎結構上。 這些環境與 Azure 部署環境不同。
部署
部署是使用者可以存取 API 的位置 (位址)。 API 可以有多個部署,例如不同的預備環境或區域。 例如,API 可能在內部預備環境中有一個部署,在生產環境中有另一個部署。 每個部署都與特定 API 定義相關聯。
中繼資料
在 Azure API 中心,您可藉由設定中繼資料值來組織 API、部署和其他資產,這些屬性可用於搜尋和篩選及強制執行治理標準。 API 中心提供幾種常見的內建中繼資料屬性,如「API 類型」和「生命週期階段」。 API 中心擁有者可以在中繼資料結構描述中定義自訂中繼資料,以組織其 API、部署和環境,藉此增強內建中繼資料。 例如,建立「API 核准者」屬性,以識別負責核准 API 以供使用的個人。
Azure API 中心支援陣列、布林值、數字、物件、預先定義選項和字串類型的自訂中繼資料。
Azure API 中心的中繼資料結構描述與 JSON 和 YAML 結構描述規格相容,以允許開發人員工具和自動化管線中的結構描述驗證。