Apollo Federation

这是 GraphQL 库版本 7 的文档。对于长期支持 (LTS) 版本 5，请参阅GraphQL 库版本 5 LTS。

本指南演示了如何使用 Neo4j GraphQL 库创建子图，以便使用 Apollo Federation 组合成超图。

目标是将以下单体模式转换为子图模式，以便在 Federation 网关后使用

import { ApolloServer } from "@apollo/server";
import { startStandaloneServer } from "@apollo/server/standalone";
import { Neo4jGraphQL } from "@neo4j/graphql";
import neo4j from "neo4j-driver";

const typeDefs = `#graphql
  type User @node {
    id: ID!
    name: String!
  }
`;

const driver = neo4j.driver(NEO4J_URI, neo4j.auth.basic("username", "password"));

const neo4jGraphQL = new Neo4jGraphQL({
  typeDefs,
  driver,
})

const schema = await neo4jGraphQL.getSchema();

const server = new ApolloServer({
  schema,
});

const { url } = await startStandaloneServer(server);
console.log(`🚀  Server ready at ${url}`);

设置

要继续转换，请按照以下步骤操作

  1. 为新项目创建一个目录并 cd 进入该目录

    mkdir neo4j-graphql-subgraph-example
cd neo4j-graphql-subgraph-example

  2. 使用 npm 初始化一个新的 Node.js 项目

    npm init --yes
npm pkg set type="module"

    本操作指南使用 ES Modules 设置项目，这允许使用诸如顶层 await 等功能。

  3. 选择 TypeScript 或 JavaScript 继续设置

  1. 创建一个 src 目录，并在其中创建一个空的 index.js 文件，用于存放代码的入口点

    mkdir src
touch src/index.js

  2. 将 package.json 文件中的默认 scripts 条目替换为以下内容

    {
  // ...etc.
  "scripts": {
    "start": "node index.js"
  }
  // other dependencies
}

  1. 创建一个 src 目录，并在其中创建一个空的 index.ts 文件，用于存放代码的入口点

    mkdir src
touch src/index.ts

  2. 安装使用 TypeScript 项目所需的开发依赖项

    npm install --save-dev typescript @types/node @tsconfig/node-lts

  3. 创建一个空的 tsconfig.json 文件，其中包含 TypeScript 的编译器配置

    touch tsconfig.json

  4. 将以下配置添加到 tsconfig.json 文件中

    {
  "extends": "@tsconfig/node-lts/tsconfig.json",
  "compilerOptions": {
    "rootDir": "src",
    "outDir": "dist",
  }
}

    此配置扩展了由上面安装的 @tsconfig/node-lts 包提供的 Node.js LTS 社区基础。有关可用选项的更多信息，请参阅 TypeScript 编译器文档。

  5. 将 package.json 文件中的默认 scripts 条目替换为以下内容

    {
  // ...etc.
  "scripts": {
    "compile": "tsc",
    "start": "npm run compile && node ./dist/index.js"
  }
  // other dependencies
}

  1. 要继续设置，请运行以下命令安装所需的依赖项

    npm install @apollo/server @neo4j/graphql graphql neo4j-driver

    要安装的依赖项有

    • @apollo/server 是 Apollo Server 的库，本指南使用它来托管子图。

    • @neo4j/graphql 是 Neo4j GraphQL 库，它将 GraphQL 转换为 Cypher 并返回结果。

    • graphql 是 GraphQL 规范的参考实现。它是 @neo4j/graphql 正常运行所必需的。

    • neo4j-driver 是 Neo4j 驱动程序的库，执行针对数据库的 Cypher 查询时需要它。

选择加入 Federation

为了使一组类型定义可用作 Federation 的子图，它们必须包含以下模式扩展

const typeDefs = `#graphql
  extend schema @link(url: "https://specs.apollo.dev/federation/v2.0", import: ["@key"])

  type User @node {
    id: ID!
    name: String!
  }
`;

此示例仅包含 Federation @key 指令。要使用更多 Federation 指令，请将它们添加到 import 数组中。

定义实体

将类型定义为实体允许其他子图向 Movie 类型贡献字段。为此，请使用 @key 指令将一个字段（或多个字段）指定为键

const typeDefs = `#graphql
  extend schema @link(url: "https://specs.apollo.dev/federation/v2.0", import: ["@key"])

  type User @key(fields: "id") @node {
    id: ID!
    name: String!
  }
`;

尽管此示例仅添加了 @key 指令，但请考虑在 id 字段上使用 @id 指令。Federation 网关期望每个键解析为一个结果，因此确保这些值在数据库中是唯一的，这是一个很好的实践。

生成子图模式

使用 Neo4j GraphQL 库时，可以通过调用 getSubgraphSchema 而不是 getSchema 来生成子图模式。为此，需要更改以下行

const schema = neo4jGraphql.getSubgraphSchema();

结论

通过组合所有先前的代码片段，您应该得到以下内容

import { ApolloServer } from "@apollo/server";
import { startStandaloneServer } from "@apollo/server/standalone";
import { Neo4jGraphQL } from "@neo4j/graphql";

const typeDefs = `#graphql
  type User @key(fields: "id") @node {
    id: ID!
    name: String!
  }
`;

const driver = neo4j.driver("bolt://localhost:7687", neo4j.auth.basic("username", "password"));

const neo4jGraphQL = new Neo4jGraphQL({
  typeDefs,
  driver,
})

const schema = await neo4jGraphQL.getSubgraphSchema();

const server = new ApolloServer({
  schema,
});

const { url } = await startStandaloneServer(server);
console.log(`🚀  Server ready at ${url}`);

为了进一步迭代，此子图还可以组合成一个超图。请查看 Apollo 的指南以获取更多说明

© . All rights reserved.