Neo4j GraphQL Toolbox

这是 GraphQL Library 7 版本的文档。对于长期支持 (LTS) 版本 5,请参考 GraphQL Library 5 LTS 版本

The Neo4j GraphQL Toolbox is an onboarding, low-code tool that can be integrated to Neo4j. It was created for development and experimentation with Neo4j GraphQL APIs. With it, you can

  1. 使用有效凭证连接到 Neo4j 数据库。

  2. 定义(或内省)类型定义。

  3. 构建 Neo4j GraphQL 架构。

  4. 实验、查询和尝试。

连接到 Neo4j 数据库

在开始使用 Toolbox 之前,请确保您已遵循所有 要求 来运行 Neo4j 数据库。您可以使用 Neo4j DesktopNeo4j AuraDB

设置类型定义

直接在 Toolbox 编辑器中设置您的类型定义,或内省您已连接的 Neo4j 数据库。

如果您遵循了 自托管 GraphQL 教程,请使用 Introspect 在 GraphQL Toolbox 中查看这些类型定义

type Product @node {
    productName: String
    category: [Category!]! @relationship(type: "PART_OF", direction: OUT)
}

type Category @node {
    categoryName: String
    products: [Product!]! @relationship(type: "PART_OF", direction: IN)
}
GraphQL Toolbox schema view

如果您在遵循 自托管 GraphQL 教程 后修改了数据库,可能会看到不同的内省结果。

构建架构并查询数据库

Build schema 将带您进入 Query editor 选项卡。

查询 Neo4j 数据库。粘贴以下内容或与 @neo4j/graphql 库在 Explorer 中自动生成的 GraphQL 查询和变更进行交互。

{
  products {
    productName
  }
}
GraphQL Toolbox editor view

该查询返回数据库中唯一产品的名称

{ "data": { "products": [{ "productName": "New Product" }] } }

将类型定义存为收藏

您可以将类型定义存为收藏,并访问一系列可供使用的设置。在 Type definitions 选项卡中,星形图标将把它保存为收藏

Save a type definition as favorite