Fabric API for GraphQL 架构视图和架构资源管理器

GraphQL 架构基于 GraphQL 架构定义语言 (SDL),定义了 API 中公开的数据格式。 它是一个抽象层,为使用者提供了灵活性,同时隐藏了后端实现细节。 该架构基于包含字段的对象类型的集合。

“架构”视图

可在“数据开发”屏幕左下角选择“架构”来访问架构视图。 该视图显示了基于文本的 GraphQL SDL 版本,其中包含生成的类型、字段和操作。

下图是架构视图的一个示例,包含此架构中可用对象的广泛列表。

注意

架构视图为只读视图。 只能在架构资源管理器中修改对象。

“API 架构视图”屏幕的屏幕截图,其中包括左窗格中的架构资源管理器。

架构资源管理器

架构资源管理器位于左侧的窗格中,在查询视图中使用编辑器时也可以使用。 资源管理器允许用户快速可视化 API 中定义的可用类型和字段以及查询和突变。

连接到数据源时,从所选对象中获取的所有 GraphQL 类型都将显示在架构资源管理器列表中。 这些类型显示在从中派生的数据源的名称下。 在下图中,你可以看到从 AdventureWorks SQL 分析终结点的 SalesOrderDetail 表中派生出来的 SalesOrderDetail 类型。

“架构资源管理器”窗格的屏幕截图,其中显示了名为 SalesOrderDetail 的示例数据源下可用类型的展开列表。

除了类型之外,Fabric API for GraphQL 还会为你选择公开的任何新对象自动生成查询和突变。

在我们的 AdventureWorks 示例中,展开查询列表会显示为数据源自动生成的查询。

“架构资源管理器”窗格的屏幕截图,其中显示了自动生成的查询的展开列表。

若要查看 API 自动生成的突变,请展开架构资源管理器树中的突变节点。

“架构资源管理器”窗格的屏幕截图,其中显示了自动生成的突变的展开列表。

使用架构资源管理器修改对象

在 API 创建对象后,可以使用架构资源管理器修改对象。 在以下示例中,我们选择了从 AdventureWorks 数据库派生的 SalesOrderDetail 类型旁边的省略号:

选中省略号的“架构资源管理器”屏幕截图,其中显示了可用的菜单选项。

以下选项可用于类型:

  • 更新架构 - 允许使用数据源中的新对象更新架构。
  • 重命名 - 更改对象的名称。 请注意:此更改只会影响 API 架构,对派生它的原始数据源对象没有影响。
  • 从架构中删除 - 实际上是从 GraphQL 架构中删除对象,因此无法再引用它。
  • 管理关系 - 开始体验关系管理。 有关详细信息,请参阅 在 Fabric API for GraphQL 中管理关系
  • 属性 - 显示有关对象的其他信息。

启用和禁用查询和突变

查询和突变的启用/禁用功能为管理员和开发人员提供对 API 访问和使用情况的精细控制。 通过它,你可以选择性地激活或停用 GraphQL 架构中的特定查询和突变。 这样,你便可以动态管理 API 功能,而无需修改代码或部署更改。

架构资源管理器中的查询和突变有两个附加选项:

  • 禁用 - 防止任何请求执行查询或突变。 如果尝试执行,则会返回错误。 禁用查询或突变后,将发生架构重载,并且查询或突变在架构资源管理器中灰显。

禁用架构资源管理器上显示的查询或突变选项的屏幕截图。

  • 启用 - 重新启用以前禁用的查询或突变。 选择“启用”选项后发生的架构重载操作上立即执行该项。

启用架构资源管理器上显示的突变选项查询的屏幕截图。

请注意,只能删除从存储过程自动生成的查询或突变。 删除后,可以使用“获取数据”或“更新架构”选项重新添加它们。