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

API 探索器使用您真实的生产数据。

---

内省

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

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

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

此外，内省帮助我们检测查询中的错误。系统会识别不同类型何时不可用或配置不正确——例如，Number 应该是 String、表中不可用的字段以及验证。因此，使用 API 探索器时，将鼠标悬停在红色波浪线上以显示错误提示。

访问 API 文档

API 探索器包含一个内置的架构参考，帮助您在编写查询时理解数据模型。有两种访问方式：

1. 文档面板

单击位于右上角工具栏中的 Documentation（文档）按钮。这将切换左侧的侧边栏，您可以在其中浏览和搜索所有可用的 Queries、Mutations 和 Types。

2. 上下文快速导航

如图所示，您可以直接跳转到您正在键入的特定字段的文档：

• 将鼠标悬停在编辑器中的字段名称（例如 cities）上。将出现一个工具提示，显示其返回类型（例如 CitiesConnection）。
• 单击工具提示内的类型名称。
• 文档侧边栏将自动打开并直接导航到该特定类型定义，向您显示所有可用的子字段（如 items、count、aggregates）及其描述。

构建器

构建器是一个可视化查询构建工具，通常默认在 API 探索器的左侧打开。它允许您选择字段和参数以自动生成有效的 GraphQL 语法。

如果您已关闭面板或看不到它，可以轻松重新打开：

• 查找位于右上角工具栏中的 Composer（构建器）按钮。
• 它紧邻 Documentation（文档）按钮。
• 单击此按钮将切换构建器侧边栏，将可视化编辑器带回视图。

尝试打开 cities 并勾选 count 选项。以下查询将填充文本区域，可以执行以检查有多少个城市。

query MyQuery {
  cities {
    items {
      nameCity
    }
  }
}