跳转到内容

API 浏览器

API 浏览器是一个浏览器内的 IDE,用于探索项目的 GraphQL API。它允许 Archie Core 开发人员在工作区内轻松构建和执行 GraphQL 查询。

API 浏览器使用您真实的生产数据。

alt text

GraphQL 架构具有内置的内省系统,可发布架构的结构。这使得 API 浏览器在编写 GraphQL 查询时能够提供强大的自动完成功能。

进入 items 块后,键入 “em”。从这里,可以轻松地从 API 中的可用操作中查看和选择 email 字段。自动完成是基于您在正在构建的查询中的位置而上下文相关的,并根据正在键入的内容过滤选项。

alt text

要手动激活自动完成菜单并查看可用选项,请按组合键 [Shift] + [SPACE]。此操作将显示上下文菜单,允许您从列表中选择所需的字段,例如 items

alt text

此外,内省帮助我们检测查询中的错误。系统会识别不同类型何时不可用或配置不正确。因此,使用 API 浏览器时,将鼠标悬停在红色波浪线上以显示错误提示。

alt text

另一种方便的方法来调查当前工作区中可用的许多 GraphQL 操作和类型是使用文档。

API 浏览器包含一个内置的架构参考,帮助您在编写查询时理解数据模型。

单击位于右上角工具栏中的 Documentation 按钮。

alt text

您可以直接跳转到您正在键入的特定字段的文档。

alt text

构建器是一个可视化查询构建工具,通常默认在 API 浏览器的左侧打开。

alt text

query MyQuery {
cities {
items {
nameCity
}
}
}

alt text