@apollo/subgraph

中文文档
2.15.1发布于 2026/09/15MITTypeScriptCommonJS构建来源已验证近 30 天下载 423.1万

阿波罗联邦以图克勒-js为基础的子图公用事业

中文使用文档
文档目录8 节
  1. 安装
  2. 使用量
  3. API 密码
  4. 发展
  5. 联系人
  6. 捐款
  7. 警卫
  8. 许可证

Continuous Integration MIT License NPM Join the community forum

@ apollo/ 子图

阿波罗联邦 graphql-js 生态系统.

@apollo/subgraph 建在顶部 graphql-js 并提供了转换逻辑 使您的 GraphQL 计程器兼容 . buildSubgraphSchema 添加常见 联合会类型定义(如:. Any 斯卡尔, _Entity 工会、联邦指令、, ,并允许您简单指定您的联邦实体解析器.

安装

要求节点.js 22或后.

npm install @apollo/subgraph graphql

使用量

import { ApolloServer } from '@apollo/server';
import { startStandaloneServer } from '@apollo/server/standalone';
import { buildSubgraphSchema } from '@apollo/subgraph';
import gql from 'graphql-tag';

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

  type Query {
    product(id: ID!): Product
  }

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

const resolvers = {
  Query: {
    product: (_source, { id }) => products.find((product) => product.id === id),
  },
  Product: {
    // Called for each entity representation the router sends to `_entities`.
    __resolveReference: (reference) =>
      products.find((product) => product.id === reference.id),
  },
};

const server = new ApolloServer({
  schema: buildSubgraphSchema([{ typeDefs, resolvers }]),
});

await startStandaloneServer(server, { listen: { port: 4001 } });

API 密码

  • buildSubgraphSchema(modulesOrSDL) ——构建可执行子图计划. 接受一个 DocumentNode,或一系列文档或 { typeDefs, resolvers } 模块.
  • printSubgraphSchema(schema) 印出完整的子图计划, 包括联邦指令和类型.
  • addResolversToSchema(schema, resolvers) 将解析器地图附在 现有计划、理解 __resolveReference 和平常一样 __resolveType 编号 : __isTypeOf。 。 。 .
  • entitiesResolver({ representations, context, info }) - 那个 _entities 解析器,导出给集合自己根字段的库.

实体参考资料通过 __resolveReference或来自 解析器映射或从 extensions.apollo.subgraph.resolveReference 在类型.

发展

npm install
npm run build
npm test

这个 compatibility/ 工作空间运行 阿波罗联邦子图兼容套件 针对这个库,使用道克来作路由器和参考子图. 见其 读取。 。 。 .

npm run compatibility --workspace @apollo/subgraph-compatibility

联系人

如果您对库或代码有特定问题,请在 阿波罗社区论坛。 。 。 .

捐款

见 捐款额 详细情况.

在你建立你的当地分支后,看看我们的公开问题,看看你们可以在哪里作出贡献.

警卫

有关如何联系小组处理安全问题的更多信息,见我们 安全政策。 。 。 .

许可证

这个图书馆的许可依据是 《麻省理工学院许可证》。 。 。 .

版本与发布记录

@apollo/subgraph 共发布 193 个版本,首次发布于 2021/10/08;过去 12 个月发布了 30 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.15.1latest2026/09/151 个月前
2.15.02026/08/292 个月前
2.15.0-alpha.02026/08/292 个月前
15.0.0-alpha.12026/08/292 个月前
2.14.42026/08/192 个月前
2.14.32026/07/233 个月前

其他发布通道:latest-1 → 0.6.1,testing → 2.7.4-testing.1,connectors → 2.9.0-connectors.9,beta → 2.9.0-beta.0,preview → 2.13.0-preview.2,next → 2.13.3。

关于 @apollo/subgraph 的常见问题

@apollo/subgraph 是什么?

阿波罗联邦以图克勒-js为基础的子图公用事业

如何安装 @apollo/subgraph?

在项目目录运行 npm install @apollo/subgraph,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:graphql(^16.11.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@apollo/subgraph 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@apollo/subgraph 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@apollo/subgraph 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@apollo/subgraph 可以商用吗?

@apollo/subgraph 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@apollo/subgraph 的下载量有多少?

根据 npm 官方下载统计,@apollo/subgraph 在 2026/10/07 – 2026/11/05 这 30 天内被下载 4,230,668 次,日均约 141,022 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@apollo/subgraph 还在维护吗?

最新版本 2.15.1 发布于 2026/09/15(1 个月前);至今共发布 193 个版本,其中过去 12 个月发布了 30 个;首次发布于 2021/10/08。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。