Microsoft網狀架構 REST API 的設計目的是協助開發人員將 Fabric 自動化。 網狀架構 REST API 參考頁面(檔)是結構化的,可協助開發人員尋找所需的資訊。
參考頁面分成兩個主要區段:
核心 API - 核心 API 會提供Microsoft Fabric 內所有專案的資訊與功能。 核心 API 並非一個工作負載專屬,而且可用於所有工作負載。 核心 API 是建立、讀取、更新和刪除 (CRUD) API。 您可以使用它們來建立或更新 Fabric 項目及其通用屬性。 在執行批次作業時,您可以使用核心 API,這些作業不需要強迫操控特定項目類型的屬性。
工作負載 API - 工作負載 API 以 Fabric 中的特定項目類型為目標。
核心和工作負載參考頁面區段會依字母順序列出所有 API。 每個區段都包含概觀,其中包含區段中所有 API 的清單,以及區段中 API 的字母清單。
項目特定條目
專案特定區段會詳細說明 Fabric 中每個專案類型的細節。 每個項目類型條目都包含:
概觀:專案類型的簡短描述。
端點:列出項目類型的可用端點,以及參數、要求和回應格式的詳細數據,以及範例。
模型:定義專案類型的數據模型,並指定屬性和類型。
動作:列出專案類型的可用動作,包括參數、要求和回應格式的詳細數據,以及範例。
使用項目特別條目來了解與特定項目類型相關的 API 的獨特層面,以及進行與該項目類型相關操作的指南。
參考頁面結構
每個參考頁面都有下列各節:
概觀 - 描述 API 的文章頂端的簡短段落。
許可權 - 呼叫 API 所需的用戶權力清單。
必要範圍 - API 所需的許可權清單(也稱為範圍)。
限制 - (選擇性) API 的限制清單。
介面 - 顯示 API 的 HTTP 格式。
URI 參數 - 用來識別特定資源或資源的參數清單。
請求主體 - 可傳遞至 API 的屬性清單。
回應 - API 中可能回應的清單。
範例 - 示範如何使用 API 的範例清單。
定義 - 定義可傳遞至 API 之物件結構和屬性的參數。
新的 API 檔參考結構旨在提供清楚且一致的方式來存取和使用 API 資訊。 藉由分隔核心區段和項目特定條目,我們希望能讓開發人員更輕鬆地尋找和使用整合至 Microsoft Fabric 服務所需的資訊。
歡迎您對如何改善檔和 API 的意見反應和建議。