本文提供中繼資料的背景資訊，以及如何在 Azure API 中心中使用它進行 API 控管。 您可以定義和設定中繼資料，以組織和篩選 API 中心中的 API 和其他實體。 中繼資料可以是內建或自訂，您可以開發中繼資料結構描述，以跨 API、環境和部署之間強制執行一致性。
內建中繼資料
在 API 中心建立或更新 API、環境和部署時，您可以設定某些內建中繼資料內容，例如 API 類型 (REST、WSDL 等)。
下表列出針對 Azure API 中心實體提供的內建中繼資料。 如需詳細資訊，請參閱 API 中心 REST API 參考。 資料表不包含標準 Azure 屬性，例如資源識別碼、顯示標題或描述。 並非所有屬性皆為必要項目。
應用程式介面（API）
| 後設資料 | Description | 範例值 |
|---|---|---|
| kind | API 的種類 (類型) | REST、SOAP、GraphQL |
| 生命週期階段 | API 開發生命週期的階段 | 設計、開發 |
| 使用權 | API 的授權資訊 | SPDX 識別碼、授權文字的連結 |
| 外部文件 | API 外部文件的網站 | 指向文件的 URL |
| 連絡人資訊 | API 的連絡點 | 電子郵件地址、姓名、URL |
| 服務條款 | API 的服務條款 | 指向服務條款的 URL |
Environments
| 後設資料 | Description | 範例值 |
|---|---|---|
| kind | 環境的種類 (類型) | 生產、暫存、開發 |
| 伺服器 | 環境的伺服器資訊 | 指向環境伺服器的類型和 URL |
| 伺服器類型 | 環境伺服器的類型 | API 管理伺服器、Kubernetes 伺服器、Apigee 伺服器 |
| 上線 | 環境的上線資訊 | 指向環境開發人員入口網站的指示和 URL |
部署
| 後設資料 | Description | 範例值 |
|---|---|---|
| 伺服器 | 部署的伺服器資訊 | 指向部署伺服器的 URL |
| 狀態 | 部署的狀態 | 使用中、非使用中 |
自訂中繼資料
使用 Azure 入口網站、Azure API 中心 REST API 或 Azure CLI 來定義自訂中繼資料，以協助組織和篩選 API 中心中的 API、環境和部署。 Azure API 中心支援下列類型的自訂中繼資料。
| 類型 | Description | 範例名稱 |
|---|---|---|
| boolean | True 或 False | IsInternal |
| number | 數值 | YearOfCreation |
| 字串 | 文字值 | GitHubRepository |
| 陣列 | 值清單 | 標籤 |
| 內建選項 | 內建選項清單 | Department |
| 物件 | 由多個類型組成的複雜物件 | 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。
