# @apollographql/apollo-upload-server 中文文档

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

版本：5\.0\.3
npm 元数据更新时间：2022-10-21T19:11:19.770Z
中文译文更新时间：2026-11-06T11:05:48.036Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：29.4 kB，12 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- Node.js 要求：\>=6\.10
- 运行依赖：3 个
- peer 依赖：graphql ^0\.13\.1
- 首次发布：2018-08-20T17:36:41.833Z
- 最新版本发布：2018-08-20T19:20:39.981Z
- 近 30 天下载量：5716（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

增强阿波罗图形QL 服务器通过 GraphQL 突变上传直观文件 .

## 安装

```sh
npm install @apollographql/apollo-upload-server
```

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

## README

![Apollo upload logo](https://cdn.rawgit.com/jaydenseric/apollo-upload-server/6831fef/apollo-upload-logo.svg)

# apollo 上载服务器

[![npm version](https://img.shields.io/npm/v/apollo-upload-server.svg)](https://npm.im/apollo-upload-server) ![Licence](https://img.shields.io/npm/l/apollo-upload-server.svg) [![Github issues](https://img.shields.io/github/issues/jaydenseric/apollo-upload-server.svg)](https://github.com/jaydenseric/apollo-upload-server/issues) [![Github stars](https://img.shields.io/github/stars/jaydenseric/apollo-upload-server.svg)](https://github.com/jaydenseric/apollo-upload-server/stargazers) [![Travis status](https://img.shields.io/travis/jaydenseric/apollo-upload-server.svg)](https://travis-ci.org/jaydenseric/apollo-upload-server)

增强 [阿波罗](https://apollographql.com/) 用于通过 GraphQL 查询或突变上传直观文件。 与 a 一起使用 [图QL 多部分请求 spec 客户端执行](https://github.com/jaydenseric/graphql-multipart-request-spec#client) 例如 [apollo-上载客户端](https://github.com/jaydenseric/apollo-upload-client)。 。 。 .

## 设置

使用端点依赖安装 [无](https://www.npmjs.com/)数字 :

```shell
npm install apollo-upload-server graphql
```

之前添加中间软件 [图表ql 服务器](https://github.com/apollographql/graphql-server)。 。 。 .

### 选项

-   `maxFieldSize` (整数): Max 允许在字节中非文件多部分形式字段大小; 足够您查询( 默认:1 MB) .
-   `maxFileSize` (整数):最大允许的文件大小以字节为单位(默认:无限).
-   `maxFiles` (整数):最大允许的文件数量(默认:无限).

### [科亚](http://koajs.com/)

```js
import { apolloUploadKoa } from 'apollo-upload-server'

// …

router.post(
  '/graphql',
  koaBody(),
  apolloUploadKoa(/* Options */),
  graphqlKoa(/* … */)
)
```

### [快递](http://expressjs.com/)

```js
import { apolloUploadExpress } from 'apollo-upload-server'

// …

app.use(
  '/graphql',
  bodyParser.json(),
  apolloUploadExpress(/* Options */),
  graphqlExpress(/* … */)
)
```

### 自定义中间软件

中间软件包装合成函数 `processRequest` 接受节点js请求和可选 [选项对象](https://npmcn.com/package/%40apollographql/apollo-upload-server/#readme-options) 作为论据。 它返回一个承诺,解决GraphQL服务器要消耗的操作对象(通常是请求正文). 导入它以创建自定义中间软件 :

```js
import { processRequest } from 'apollo-upload-server'
```

### `Upload` 斯卡尔

文件上传承诺可以解析包含:

-   `stream`
-   `filename`
-   `mimetype`
-   `encoding`

必须在您的类型和解决者中添加:

```js
import { makeExecutableSchema } from 'graphql-tools'
import { GraphQLUpload } from 'apollo-upload-server'

const schema = makeExecutableSchema({
  typeDefs: `scalar Upload`,
  resolvers: { Upload: GraphQLUpload }
})
```

## 使用量

文件通过 a 上传 [图QL 多部分请求](https://github.com/jaydenseric/graphql-multipart-request-spec) 显示为 [`Upload` 分级](https://npmcn.com/package/%40apollographql/apollo-upload-server/#readme-upload-scalar) 在解析器参数中。 上传流可用于将文件存储在本地文件系统或云中. 另见 [apollo-上载客户端使用](https://github.com/jaydenseric/apollo-upload-client#usage) 编辑 [示例 API 和客户端](https://github.com/jaydenseric/apollo-upload-examples)。 。 。 .

## 支助

-   节点.js v 6.10+,参见 `package.json` `engines`。 。 。 .

## 常见问题

### @apollographql/apollo-upload-server 是什么？

增强阿波罗图形QL 服务器通过 GraphQL 突变上传直观文件 \.

### 如何安装 @apollographql/apollo-upload-server？

在项目目录运行 npm install @apollographql/apollo-upload-server，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：graphql（^0\.13\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @apollographql/apollo-upload-server 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/apollographql\_\_apollo-upload-server 是否存在。

### @apollographql/apollo-upload-server 支持 ESM 还是 CommonJS？

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

### @apollographql/apollo-upload-server 需要什么版本的 Node\.js？

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

### @apollographql/apollo-upload-server 可以商用吗？

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

### @apollographql/apollo-upload-server 的下载量有多少？

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

### @apollographql/apollo-upload-server 还在维护吗？

最新版本 5\.0\.3 发布于 2018/08/21（8 年前）；至今共发布 3 个版本，其中过去 12 个月发布了 0 个；首次发布于 2018/08/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。