Azure API 中心 - 重要概念

本文說明 Azure API 中心的重要概念。 Azure API 中心可讓您在集中式位置追蹤 API，以進行探索、重複使用和治理。

資料模型

下圖顯示 Azure API 中心的主要實體，以及它們彼此的關聯方式。 如需這些實體和相關概念的詳細資訊，請參閱下列各節。

API

Azure API 中心的最上層邏輯實體，API 代表您想要追蹤的任何真實世界 API。API 中心可以包含任何類型的 API，包括 REST、GraphQL、gRPC、SOAP、WebSocket 和 Webhook。

API 可由任何 API 管理解決方案管理（例如 Azure API 管理 或其他提供者的解決方案），或非受控。

Azure API 中心中的 API 清查是設計成由 API 項目經理或 IT 系統管理員建立和管理。

API 版本

API 版本控制是管理 API 變更，並確保這些變更不會中斷用戶端的做法。 API 可以跨生命週期階段有多個版本，每個版本都與特定的 API 變更一致。 某些版本可能會導入重大或重大變更，而其他版本則新增了次要改善。 API 版本可以是任何生命週期階段 ，從設計、預覽、生產或已被取代。

API 定義

每個 API 版本最好由至少一個定義定義定義，例如 REST API 的 OpenAPI 定義。 Azure API 中心允許格式化為文字的任何 API 定義檔案（YAML、JSON、Markdown 等等）。 您可以上傳 OpenAPI、gRPC、GraphQL、AsyncAPI、WSDL 和 WADL 定義等。

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 架構規格相容，以允許開發人員工具和自動化管線中的架構驗證。

相關內容

• 什麼是 Azure API 中心?
• API 治理的元數據