# @apollo/server-gateway-interface 中文文档

规范地址：https://npmcn.com/package/%40apollo/server-gateway-interface/

版本：2\.0\.0
npm 元数据更新时间：2026-01-22T17:30:10.234Z
中文译文更新时间：2026-11-06T10:54:57.889Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40apollo/server-gateway-interface
原文对照：https://npmcn.com/package/%40apollo/server-gateway-interface/?lang=original
项目主页：https://github.com/apollographql/apollo-server#readme
源码仓库：https://github.com/apollographql/apollo-server

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：122 kB，15 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：graphql 14\.x \|\| 15\.x \|\| 16\.x
- 首次发布：2022-08-08T22:35:46.760Z
- 最新版本发布：2025-07-17T16:58:17.056Z
- 近 30 天下载量：13219514（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 0 个）

## 中文简介

连接阿波罗网关到阿波罗服务器的界面

## 安装

```sh
npm install @apollo/server-gateway-interface
```

也可以使用：`pnpm add @apollo/server-gateway-interface`、`yarn add @apollo/server-gateway-interface`、`bun add @apollo/server-gateway-interface`

## README

# 阿波罗服务器/ Gateway 接口

本套件定义了阿波罗服务器和阿波罗网关接口的TypeScript类型. 它没有运行时代码 .

本套件中的类型描述API为"Gateway 0.35.0"(ie,并带有"Schema LoadOrUpdate"). 它是取自阿波罗服务器3 `apollo-server-types` 软件包。 类型名称大多被更改为从 `Gateway`,这样它们就能更好地与同名类型共存。 (因为TypeScript一般是结构键入的,这个是OK. )

注意缓存范围字段(例如: `requestContext.overallCachePolicy.scope`定义为: `any` 本包中。 这是因为在AS3中,这种型号是enum,而TypeScript中的enum是: _没有_ 结构打字. 因此,如果我们不依靠AS3(或更新AS3使其定义从共享的某个地方得到),那么我们实际上不能创建这种类型的对象.

我们更新了 `@apollo/gateway` (v0和v2) 从此包定义其类型而不是 `apollo-server-types`。这使得Gateway能够兼容AS v3-v5(甚至AS2,用于Gateway 0.x),而不需要将两个软件包的代码拉入TypeScript构建中.

阿波罗服务器直接依赖于这个软件包,并利用其类型来构建其通向"Gateway"的呼叫.

## 常见问题

### @apollo/server-gateway-interface 是什么？

连接阿波罗网关到阿波罗服务器的界面

### 如何安装 @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 和提交记录判断。