入门
入门Voyager 客户端入门

Voyager 客户端入门

Gato GraphQL 提供 GraphQL Voyager 客户端,可以交互式地可视化 GraphQL Schema。点击插件菜单中的「Interactive Schema」即可访问:

GraphQL Voyager 客户端

Voyager 提供 GraphQL Schema 的全局鸟瞰视图:

查询数据的 Schema 可视化

它通过箭头显示类型之间的连接,让您轻松理解 Schema 中所有元素之间的关联:

Schema 元素

Schema 有一个起始点,即计算所有关系的基础类型。默认情况下,这是查询根(在此示例中通过 QueryRoot 类型处理),显示在底部的浮动面板中。要可视化与 mutation 相关的 Schema,可以选择对应的 mutation 根类型(在此示例中为 MutationRoot):

GraphQL 类型,显示在浮动面板上

从另一个 GraphQL 类型切换视图

已切换至 mutation 根的视图

点击 Schema 上的某个类型,将高亮显示其连接,并展示其字段的元数据(在左侧面板中点击类型名称效果相同):

高亮显示类型

左侧面板上的搜索输入框可用于筛选 Schema 元素:

筛选 Schema 元素

点击某个连接,将在 Schema 和左侧面板中同时高亮显示:

高亮显示连接

可以使用鼠标(以及屏幕右下角的按钮)在图中进行导航,包括缩放、向任意方向移动以及聚焦到元素:

导航图

底部浮动面板提供了一些额外选项:

  • "Sort by alphabet" — 按字母顺序对每个类型中的所有字段排序
  • "Skip Relay" — 隐藏 Relay 的包装类
  • "Skip deprecated" — 隐藏所有已废弃的字段
  • "Show leaf fields" — 显示所有非连接字段

额外选项