使用元數據進行 API 治理
本文提供元數據的相關背景，以及如何在 Azure API 中心用於 API 控管。 您可以定義並設定元數據，以組織及篩選 API 中心中的其他 實體 。 元數據可以內建或自定義，而且您可以開發元數據架構，以在 API、環境和部署之間強制執行一致性。
內建元數據
在 API 中心建立或更新 API、環境和部署時，您可以設定特定的內建元數據屬性，例如 API 類型（REST、WSDL 等等）。
下表列出針對 Azure API 中心實體提供的內建元數據。 如需詳細資訊，請參閱 API 中心 REST API 參考。 數據表不包含標準 Azure 屬性，例如資源識別碼、顯示標題和描述。 並非所有屬性都是必要的。
API
| 中繼資料 | 描述 | 範例值 |
|---|---|---|
| kind | API 的種類（類型） | REST、SOAP、GraphQL |
| 生命周期階段 | API 開發生命周期的階段 | 設計、開發 |
| license (授權) | API 的授權資訊 | SPDX識別碼，授權文字的連結 |
| 外部檔 | API 的外部文件網站 | 指向檔的 URL |
| 聯繫人資訊 | API 的連絡點 | 電子郵件地址、名稱、URL |
| 服務條款 | API 的服務條款 | 指向服務條款的 URL |
環境
| 中繼資料 | 描述 | 範例值 |
|---|---|---|
| kind | 環境種類（類型） | 生產、預備、開發 |
| 伺服器 | 環境的伺服器資訊 | 指向環境伺服器的類型和URL |
| 伺服器類型 | 環境伺服器的類型 | API 管理 伺服器、Kubernetes 伺服器、Apigee 伺服器 |
| 上架 | 環境上線資訊 | 指向環境的開發人員入口網站的指示和URL |
部署
| 中繼資料 | 描述 | 範例值 |
|---|---|---|
| 伺服器 | 部署的伺服器資訊 | 指向部署伺服器的 URL |
| state | 部署的狀態 | 使用中、非使用中 |
自訂元數據
使用 Azure 入口網站、Azure API 中心 REST API 或 Azure CLI 定義自定義元數據，以協助組織及篩選 API 中心內的 API、環境和部署。 Azure API 中心支援下列類型的自定義元數據。
| 類型 | 描述 | 範例名稱 |
|---|---|---|
| boolean | [True] 或 [False] | IsInternal |
| 數值 | 數值 | YearOfCreation |
| 字串 | 文字值 | GitHubRepository |
| 陣列 | 值清單 | Tags (標籤) |
| 內建選擇 | 內建的選項清單 | 部門 |
| object | 由多個類型組成的複雜物件 | APIApprover |
重要
請勿在您所定義的元數據標題（名稱）中包含任何敏感性、機密或個人資訊。 這些標題會顯示在 Microsoft 用來改善服務功能的監視記錄中。 不過，其他元數據詳細數據和值是受保護的客戶數據。
將元數據指派給實體
自定義元數據屬性可以指派給 API 中心中的 API、環境或部署。 例如，將部門元數據定義並指派給 API，以便在註冊 API 或新增新的 API 版本時，指定負責 API 的部門。
如果指派給實體，則元數據為選擇性或必要專案。 例如，您可能需要 只針對 API 設定 Department 元數據，但允許 YearOfCreation 成為環境的選擇性元數據。
注意
- 隨時定義自定義元數據，並套用至 API 中心內的 API 和其他實體。
- 定義自定義元數據之後，您可以將它指派變更為實體，例如從 API 的必要變更為選擇性。
- 您可以變更元數據值，但無法刪除或變更目前在 API、環境和部署中設定的自定義元數據類型。 先從實體取消指派自定義元數據，然後您可以刪除或變更它們。
使用元數據進行治理
使用內建和自定義元數據來組織 API 中心內的 API、環境和部署。 例如：
藉由要求為 API、環境和部署設定特定元數據，在您的組織中強制執行治理標準。
依元數據值搜尋和篩選 API 中心中的 API。 您可以直接在 Azure 入口網站 的 API 頁面上篩選，或使用 Azure API 中心 REST API 或 Azure CLI 根據特定元數據的值來查詢 API。
