共用方式為


適用於 GraphQL 結構檢視器和結構探索器的 Fabric API

GraphQL 結構描述以 GraphQL 結構描述定義語言 (SDL) 為基礎,定義 API 中公開的資料格式。 它為消費者提供了靈活性,同時隱藏了後端實現細節。 結構描述使用一組包含欄位的物件類型。

結構描述檢視 \(部分機器翻譯\)

選取 資料開發 畫面左下角的 結構描述 來存取結構描述檢視。 此檢視顯示 GraphQL SDL 的文字型版本,其中包含產生的類型、欄位和作業。

下圖顯示結構描述檢視的範例,包括此結構描述中可用的物件清單。

注意

架構檢視是唯讀的。 僅在架構總管中修改物件。

API 架構檢視畫面的螢幕擷取畫面,其中包含左窗格中的架構總管。

結構描述總管

「架構瀏覽器」位於左側窗格中,當您在查詢檢視中使用編輯器時也可使用。 總管可讓使用者快速可視化可用的類型和欄位,以及 API 中定義的查詢和突變。

連線至資料來源時,您選擇的物件中可用的所有 GraphQL 型別都會顯示在 Schema 總管清單中。 這些類型會顯示在衍生來源的資料來源名稱下。 下圖顯示衍生自 AdventureWorks SQL 分析端點中 SalesOrderDetail 資料表的 SalesOrderDetail 類型。

「Schema Explorer」窗格的螢幕截圖,顯示名為 SalesOrderDetail 的範例資料源下可用的型別展開清單。

除了類型之外,適用於 GraphQL 的 Fabric API 會自動為您選擇公開的新物件產生查詢和變動。

在我們的 AdventureWorks 範例中,展開查詢清單會顯示資料來源的自動產生查詢。

架構探索器窗格的螢幕擷取畫面,顯示已展開的自動產生查詢清單。

展開 Schema 總管 樹狀結構中的變更節點,以查看 API 自動生成的變更項目。

模式瀏覽器窗格的螢幕擷取畫面,顯示自動產生的變更的展開清單。

使用架構瀏覽器修改對象

您可以在 API 為您建立物件之後,使用架構總管來修改物件。 在下列範例中,我們會選取衍生自 AdventureWorks 資料庫的 SalesOrderDetail 類型旁邊的省略號:

截圖顯示在架構總覽器中選取省略號後的可用功能選單選項。

下列選項可用於類型:

  • 更新結構描述 — 可讓您使用資料來源中的新物件來更新結構描述。

  • 重新命名 - 變更物件的名稱。 此變更 只會 影響 API 結構描述,不會影響衍生其原始資料來源物件。

  • 從結構描述中移除 — 從GraphQL結構描述中刪除物件,讓您無法再參考它。

  • 管理關係 — 開啟關係管理體驗。 如需詳細資訊,請參閱 在 Fabric API for GraphQL 中管理關聯性。

  • 屬性 - 顯示物件的其他資訊。

啟用和停用查詢和突變

查詢和突變的啟用或停用功能可讓管理員和開發人員對 API 存取和使用進行精細控制。 它可讓您選擇性地啟用或停用 GraphQL 架構中的特定查詢和突變。 這可讓您動態管理 API 功能,而不需要修改程式碼或部署變更。

資料綱要瀏覽器中的查詢與變更還有另外兩個選項:

  • 停用:防止任何要求執行查詢或變動。 如果嘗試執行,則會傳回錯誤。 停用查詢或突變之後,會重新載入結構描述,且查詢或突變會在結構描述總管中顯示為灰色。

Schema 瀏覽器中顯示的停用查詢或修改選項的螢幕擷取畫面。

  • 啟用:可讓您重新啟用先前停用的查詢或變異。 查詢或變動會在您選取 啟用 選項時發生的結構描述重新載入作業之後立即可用。

結構描述總管上顯示的啟用變更查詢選項的螢幕擷取畫面。

只能刪除從預存程序自動產生的查詢或變動。 刪除後,可以使用「 取得資料 」或 「更新結構描述 」選項重新新增它們。