共用方式為


GraphQL 架構檢視和架構總管的網狀架構 API

注意

適用於 GraphQL 的網狀架構 API Microsoft處於預覽狀態。

GraphQL 架構是以 GraphQL 架構定義語言(SDL)為基礎,會定義 API 中公開的資料格式。 這是一個抽象層,可在隱藏後端實作詳細資料的同時,為取用者提供彈性。 架構是以包含欄位的物件類型集合為基礎。

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

您可以選取資料開發 畫面左下角的架構來存取架構檢視。 此檢視會以文字為基礎的 GraphQL SDL 版本,其中包含產生的類型、欄位和作業。

下圖是架構檢視的範例,包括此架構中可用的物件廣泛清單。

注意

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

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

結構描述總管

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

當您連接到資料來源時,從您選擇的物件取得的所有 GraphQL 類型都會出現在結構描述總管清單中。 這些類型會顯示在衍生來源的資料來源名稱下。 在下圖中,您會在 AdventureWorks SQL 分析端點中看到衍生自 SalesOrderDetail 資料表的 SalesOrderDetail 類型。

架構總管 窗格的螢幕擷取畫面,其中顯示 SalesOrderDetail 範例資料來源下可用的類型展開清單。

除了類型之外,GraphQL 的網狀架構 API 也會為您選擇公開的任何新對象自動產生查詢和突變。

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

架構總管 窗格的螢幕擷取畫面,其中顯示自動產生的查詢展開清單。

若要查看 API 自動產生的突變,請展開架構總管樹狀目錄中的突變節點。

架構總管 窗格的螢幕擷取畫面,其中顯示自動產生的突變展開清單。

使用架構總管修改物件

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

架構總管 的螢幕擷取畫面,其中已選取省略號,其中顯示可用的功能表選項。

下列選項可用於類型:

  • 更新架構 - 可讓您使用資料來源中的新物件來更新架構。
  • 重新命名 - 變更物件的名稱。 請注意:這項變更只會影響 API 架構,而且不會影響衍生來源的原始資料來源物件。
  • 從架構 中移除 - 有效地從 GraphQL 架構刪除物件,讓您無法再參考它。
  • 管理關聯性 - 帶您前往關聯性管理體驗。 如需詳細資訊,請參閱 在 Fabric API for GraphQL 中管理關聯性。
  • 屬性 - 顯示物件的其他資訊。

啟用和停用查詢和突變

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

架構總管中的查詢和突變有兩個額外的選項:

  • 停用 - 防止任何要求執行查詢或突變。 如果嘗試執行,則會傳回錯誤。 一旦停用查詢或突變,就會發生架構重載,且查詢或突變在架構總管中呈現灰色。

停用架構總管上顯示之查詢或突變選項的螢幕擷取畫面。

  • 啟用 - 重新啟用先前停用的查詢或突變。 選取 啟用選項之後,即可立即執行項目的架構重載作業。

啟用架構總管上顯示之突變選項查詢的螢幕擷取畫面。

請注意,只能刪除從預存程式自動產生的查詢或突變。 刪除之後,可以使用取得資料更新架構 選項重新新增它們。