# @aws-amplify/graphql-docs-generator 中文文档

规范地址：https://npmcn.com/package/%40aws-amplify/graphql-docs-generator/

版本：4\.2\.2
npm 元数据更新时间：2026-07-23T13:50:06.832Z
中文译文更新时间：2026-11-07T09:15:05.405Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40aws-amplify/graphql-docs-generator
原文对照：https://npmcn.com/package/%40aws-amplify/graphql-docs-generator/?lang=original
项目主页：https://github.com/aws-amplify/amplify-codegen#readme
源码仓库：https://github.com/aws-amplify/amplify-codegen

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

- 包体积（解压后）：100 kB，68 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=10\.0\.0
- 运行依赖：3 个
- 首次发布：2021-01-21T23:10:11.400Z
- 最新版本发布：2026-07-23T13:50:06.643Z
- 近 30 天下载量：833769（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：191（近 12 个月 1 个）

## 中文简介

放大图ql docs 生成器插件

## 安装

```sh
npm install @aws-amplify/graphql-docs-generator
```

也可以使用：`pnpm add @aws-amplify/graphql-docs-generator`、`yarn add @aws-amplify/graphql-docs-generator`、`bun add @aws-amplify/graphql-docs-generator`

## README

# 图QL Docs 生成器

GraphQL 文档生成器需要一个计数器,并生成该计数器上所有可能的语句(queries,突变和订阅). 这可以作为新到GraphQL的用户的起点.

## 安装和执行

#### 从命令行执行 :

```
$ npm install -g @aws-amplify/graphql-docs-generator

$ graphql-docs-generator --schema 'my-graphql-sdl-schema'

$ graphql-docs-generator --schema 'my-graphql-introspection-schema' --maxDepth 2
```

#### 从节点JS或浏览器环境执行 :

添加对 `3.1.0-studio-graphql-4.0` 版本 `@aws-amplify/graphql-docs-generator` 在你身边 `package.json` 文件,安装和构建.

```
import { generateGraphQLDocuments } from '@aws-amplify/graphql-docs-generator';

const schema = 'my-graphql-sdl-schema';

// Below are the supported optional customizations and their defaults
const options = {
  maxDepth: 2
};

const generatedResult = generateGraphQLDocuments(schema, options);

// Test logs to demonstrate the output
console.log(generatedResult.queries);
console.log(generatedResult.mutations);
console.log(generatedResult.subscriptions);
console.log(generatedResult.fragments);
```

## 常见问题

### @aws-amplify/graphql-docs-generator 是什么？

放大图ql docs 生成器插件

### 如何安装 @aws-amplify/graphql-docs-generator？

在项目目录运行 npm install @aws-amplify/graphql-docs-generator，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 graphql-docs-generator，可以用 npx graphql-docs-generator 直接运行。

### @aws-amplify/graphql-docs-generator 支持 TypeScript 吗？

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

### @aws-amplify/graphql-docs-generator 支持 ESM 还是 CommonJS？

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

### @aws-amplify/graphql-docs-generator 需要什么版本的 Node\.js？

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

### @aws-amplify/graphql-docs-generator 可以商用吗？

@aws-amplify/graphql-docs-generator 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @aws-amplify/graphql-docs-generator 的下载量有多少？

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

### @aws-amplify/graphql-docs-generator 还在维护吗？

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