GraphQL 架构基于 GraphQL 架构定义语言(SDL)定义 API 中公开的数据的格式。 它为使用者提供灵活性,同时隐藏后端实现详细信息。 架构使用包含字段的对象类型的集合。
“架构”视图
通过选择数据开发屏幕左下角的 “架构 ”来访问架构视图。 此视图显示包含生成的类型、字段和作的 GraphQL SDL 的基于文本的版本。
下图显示了架构视图的示例,包括此架构中可用的对象列表。
注意
架构视图为只读视图。 仅在架构资源管理器中修改对象。
架构资源管理器
架构资源管理器位于左侧的窗格中,在查询视图中使用编辑器时也可用。 资源管理器允许用户快速可视化 API 中定义的可用类型和字段以及查询和突变。
连接到数据源时选择的所有 GraphQL 类型都显示在架构资源管理器列表中。 这些类型显示在从中派生的数据源的名称下。 下图显示了从 AdventureWorks SQL 分析终结点中的 SalesOrderDetail 表派生的 SalesOrderDetail 类型。
除了类型以外,GraphQL 的 Fabric API 还会自动生成你选择公开的新对象的查询和突变。
在我们的 AdventureWorks 示例中,展开查询列表会显示为数据源自动生成的查询。
展开 架构资源管理器 树中的突变节点以查看 API 自动生成的突变。
使用架构资源管理器修改对象
在 API 创建对象后,可以使用架构资源管理器修改对象。 在以下示例中,我们选择了从 AdventureWorks 数据库派生的 SalesOrderDetail 类型旁边的省略号:
以下选项可用于类型:
更新架构 - 允许使用数据源中的新对象更新架构。
重命名 - 更改对象的名称。 此更改 仅 影响 API 架构,不会影响从中派生它的原始数据源对象。
从架构中删除 - 从 GraphQL 架构中删除对象,因此无法再引用它。
管理关系 - 打开关系管理体验。 有关详细信息,请参阅 在 Fabric API for GraphQL 中管理关系。
属性 - 显示有关对象的其他信息。
启用和禁用查询和突变
查询和突变的启用或禁用功能为管理员和开发人员提供对 API 访问和使用情况的精细控制。 通过它,你可以选择性地激活或停用 GraphQL 架构中的特定查询和突变。 这样,你便可以动态管理 API 功能,而无需修改代码或部署更改。
架构资源管理器中的查询和突变还有其他两个选项:
- 禁用:防止任何请求运行查询或突变。 如果尝试执行,则会返回错误。 禁用查询或突变后,将发生架构重载,查询或突变在架构资源管理器中灰显。
- 启用:允许重新启用以前禁用的查询或突变。 在选择 “启用 ”选项时发生的架构重载作后,查询或突变将立即可用。
只能删除从存储过程自动生成的查询或突变。 删除后,可以使用 “获取数据 ”或 “更新架构 ”选项读取它们。
相关内容
- 详细了解 GraphQL 编辑器的 Fabric API。