# @fumadocs/graphql 中文文档

规范地址：https://npmcn.com/package/%40fumadocs/graphql/

版本：0\.5\.1
npm 元数据更新时间：2026-11-13T20:59:30.017Z
中文译文更新时间：2026-11-15T16:51:33.676Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40fumadocs/graphql
原文对照：https://npmcn.com/package/%40fumadocs/graphql/?lang=original
项目主页：https://fumadocs.dev/
源码仓库：https://github.com/fuma-nama/fumadocs

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

- 包体积（解压后）：324 kB，115 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：12 个
- peer 依赖：react ^19\.2\.0，graphql ^17\.0\.0，react-dom ^19\.2\.0，fumadocs-ui ^16\.17\.8，@types/react \*，fumadocs-core ^16\.17\.11，json-schema-typed \*
- 首次发布：2026-08-03T17:08:21.395Z
- 最新版本发布：2026-11-13T20:59:29.662Z
- 近 30 天下载量：12307（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：23（近 12 个月 23 个）

## 中文简介

为您的 GraphQL 计划生成文件

## 安装

```sh
npm install @fumadocs/graphql
```

也可以使用：`pnpm add @fumadocs/graphql`、`yarn add @fumadocs/graphql`、`bun add @fumadocs/graphql`

## README

# Fumadocs 图表QL

从 GraphQL 方案生成 API 参考文件 [福马多克](https://fumadocs.dev/)与互动游乐场.

```bash
npm i @fumadocs/graphql graphql
```

`graphql` 是同级依赖.

## 快速启动

从您的计划创建服务器实例 :

```ts
// lib/graphql.ts
import { createGraphQL } from '@fumadocs/graphql/server';

export const graphql = createGraphQL({
  input: ['./schema.graphql'],
});
```

将生成的页面添加到您的源代码 :

```ts
// lib/source.ts
import { loader } from 'fumadocs-core/source';
import { defineDocs } from 'fumadocs-mdx/macro';
import { graphql } from './graphql';

const docs = defineDocs({
  dir: 'content/docs',
});

export const source = loader(
  {
    docs: docs.toFumadocsSource(),
    graphql: await graphql.staticSource({
      // a route group, generated pages won't have a `/graphql` prefix in their URLs
      baseDir: '(graphql)',
      meta: true,
    }),
  },
  {
    baseUrl: '/docs',
    plugins: [graphql.loaderPlugin()],
  },
);
```

从客户端组件中显示 :

```tsx
// components/api-page.tsx
'use client';
import { createGraphQLPage } from '@fumadocs/graphql/ui';

export const GraphQLPage = createGraphQLPage({
  playground: {
    url: '/api/graphql',
  },
});
```

```tsx
// app/docs/[[...slug]]/page.tsx
if (page.type === 'graphql') {
  return (
    <DocsPage toc={page.data.toc} full>
      <DocsTitle>{page.data.title}</DocsTitle>
      <DocsDescription>{page.data.description}</DocsDescription>
      <DocsBody>
        <GraphQLPage {...page.data.getGraphQLPageProps()} />
      </DocsBody>
    </DocsPage>
  );
}
```

在您的全球 CSS 中导入样式 :

```css
@import '@fumadocs/graphql/css/preset.css';
```

## 选项

### 投入

`input` 接受 SDL 文件的文件路径/URL 的数组,或输入的 schema id 记录 :

-   SDL文件路径/URL,或SDL文本(包括 `extend type` (定义).
-   内测结果 (JSON).
-   `GraphQLSchema` 实例.

### 页面预设

将选项传递到 `staticSource()` 以控制生成的页面 :

-   `per: 'item'` (默认):每个操作/名称类型、使用一个页面 `groupBy` (单位:千美元)`'kind' | 'none'` 或函数)将其组合成文件夹,以及 `includeOperations`编号 :`includeTypes` 以过滤项目.
-   `per: 'file'`:每计一页.
-   `per: 'custom'`:带来自己的页面构建者.

### 用户

`createGraphQLPage()` 接受:

-   类型和操作引用的交叉链接会在您通过时预先生成 `baseUrl` (单位:千美元) `baseUrl` 您的电话 `loader()`改为: `staticSource()`; 以 `typeLinks`编号 :`operationLinks` 如果需要,请回电.
-   `playground`: 操作页面上显示的交互式游乐场 - `url` (GraphQL端点,操作通过HTTP POST发送),, `fetcher` (将默认取取器替换为代理请求),或 `render` (替换游乐场UI).
-   `shikiOptions`, (中文(简体) ), `components`,以及 `content`编号 :`schemaUI` 转换槽以进行更深入的自定义.

见 [Fumadocs 文档](https://fumadocs.dev/) 为了更多.

## 常见问题

### @fumadocs/graphql 是什么？

为您的 GraphQL 计划生成文件

### 如何安装 @fumadocs/graphql？

在项目目录运行 npm install @fumadocs/graphql，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^19\.2\.0）、graphql（^17\.0\.0）、react-dom（^19\.2\.0）、fumadocs-ui（^16\.17\.8）、fumadocs-core（^16\.17\.11）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @fumadocs/graphql 支持 TypeScript 吗？

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

### @fumadocs/graphql 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @fumadocs/graphql 可以商用吗？

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

### @fumadocs/graphql 的下载量有多少？

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

### @fumadocs/graphql 还在维护吗？

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