共用方式為


教程:定義自訂中繼資料

本教學課程說明如何定義自訂中繼資料,以協助您在 API 中心組織 API 和其他資訊。 您可以使用自訂和內建中繼資料進行搜尋和篩選,並在組織中強制執行治理標準。

如需 Azure API Center 中繼資料的詳細資訊,請參閱:

在本教學課程中,您將瞭解如何使用 Azure 入口網站來:

  • 在您的 API 中心定義自訂中繼資料
  • 檢視中繼資料結構描述

先決條件

定義中繼資料

在這裡,您會定義兩個自訂中繼資料範例: 業務線面向公眾;如果您願意,請定義您自己的其他中繼資料。 當您在清單中新增或更新 API 和其他資訊時,請設定自訂和內建中繼資料的值。

這很重要

請勿在您所定義的中繼資料屬性的標題 (名稱) 中包含任何敏感性、機密或個人資訊。 這些標題會顯示在 Microsoft 用來改善服務功能的監視記錄中。 不過,其他中繼資料詳細資料和值是您受保護的客戶資料。

  1. 登入 Azure 入口網站,然後流覽至您的 API 中心。

  2. 在側邊欄功能表的 資產 下,選取 Metadata>+ 新增 Metadata

  3. [詳細資料] 標籤上,輸入中繼資料資訊。

    1. 針對 標題,輸入 業務類別

    2. 或者,輸入 [描述]。

    3. 選取類型 [預先定義的選擇] ,然後輸入選擇,例如 Marketing、Finance、IT、Sales 等。 或者,啟用 允許選取多個值。 選取 下一步

    螢幕擷取畫面顯示如何在入口網站中新增自訂中繼資料。

  4. 指派 索引標籤上,選取 必要 以用於 API。 針對部署和環境選取 選擇性。 您可以在稍後的教學課程中新增這些實體。 選取 下一步

    入口網站中的中繼資料分配螢幕截圖。

  5. 檢閱 + 建立索引標籤上,檢閱設定,然後選取建立。

    中繼資料會新增至中繼資料頁面上的清單。

  6. 選取 [+ 新增中繼資料 ] 以新增另一個範例。

  7. [詳細資料] 標籤上,輸入中繼資料資訊。

    1. 針對 [標題],輸入 [面向公眾]。

    2. 選取類型 布林值

  8. 指派 索引標籤上,選取 必要 以用於 API。 選取 不適用 於部署和環境。

  9. 檢閱 + 建立索引標籤上,檢閱設定,然後選取建立。

    中繼資料會新增至清單。

檢視中繼資料結構描述

您可以檢視和下載 API 中心中定義的中繼資料的 JSON 結構描述。 結構包含內建和自訂元資料。

  1. 在左側功能表的 資產 下,選取 中繼資料>檢視中繼資料結構描述

  2. 選取 [ 檢視中繼資料結構描述>API] 以查看 API 的中繼資料結構描述,其中包括內建和自訂中繼資料。 您也可以檢視 API 中心中針對部署和環境定義的中繼資料綱目。

    入口網站中中繼資料結構描述的螢幕擷取畫面。

後續步驟

將 API 新增至 API 中心的詳細目錄。