@apollo/server-gateway-interface

中文文档
2.0.0发布于 2025/07/18MITTypeScriptESM + CJS近 30 天下载 1322万

Interface used to connect Apollo Gateway to Apollo Server

原始使用文档

Apollo Server/Gateway interface

This package defines TypeScript types for the interface between Apollo Server and Apollo Gateway. It contains no runtime code.

The types in this package describe the API as of Gateway 0.35.0 (ie, with onSchemaLoadOrUpdate). It is extracted from the Apollo Server 3 apollo-server-types package. Most of the type names have been changed to start with Gateway, so that they coexist better with similarly-named types. (Because TypeScript is generally structurally typed, this is OK.)

Note that the cache scope field (eg, on requestContext.overallCachePolicy.scope) is defined as any in this package. That's because in AS3 this type is an enum, and enums in TypeScript are not structurally typed. So we can't actually create an object of this type without depending on AS3 (or updating AS3 to get its definition from somewhere shared).

We have updated @apollo/gateway (v0 and v2) to define its types from this package rather than apollo-server-types. This allows Gateway to be compatible with AS v3-v5 (and even AS2, for Gateway 0.x) without needing to pull either package's code into the TypeScript build.

Apollo Server directly depends on this package and uses its types to construct its calls to the Gateway.

版本与发布记录

@apollo/server-gateway-interface 共发布 12 个版本,首次发布于 2022/08/09;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.0.0latest2025/07/181.3 年前
2.0.0-rc.0rc2025/07/081.3 年前
1.1.12023/06/273 年前
1.1.02023/01/263 年前
1.0.72022/11/243 年前
1.0.62022/11/233 年前

关于 @apollo/server-gateway-interface 的常见问题

@apollo/server-gateway-interface 是什么?

Interface used to connect Apollo Gateway to Apollo Server

如何安装 @apollo/server-gateway-interface?

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

@apollo/server-gateway-interface 支持 TypeScript 吗?

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

@apollo/server-gateway-interface 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@apollo/server-gateway-interface 可以商用吗?

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

@apollo/server-gateway-interface 的下载量有多少?

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

@apollo/server-gateway-interface 还在维护吗?

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