# @gitbook/api 中文文档

规范地址：https://npmcn.com/package/%40gitbook/api/

版本：0\.209\.1
npm 元数据更新时间：2026-11-12T15:52:24.937Z
中文译文更新时间：2026-11-16T10:30:12.948Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40gitbook/api
原文对照：https://npmcn.com/package/%40gitbook/api/?lang=original
项目主页：https://github.com/GitbookIO/integrations
源码仓库：https://github.com/GitbookIO/integrations

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

- 包体积（解压后）：4.7 MB，11 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2022-06-05T17:27:29.864Z
- 最新版本发布：2026-11-12T15:52:24.408Z
- 近 30 天下载量：283142（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：222（近 12 个月 61 个）

## 中文简介

Javascript (浏览器和节点) API 客户端 [GitBook API 密码](https://developer.gitbook.com/)。 。 。 .

## 安装

```sh
npm install @gitbook/api
```

也可以使用：`pnpm add @gitbook/api`、`yarn add @gitbook/api`、`bun add @gitbook/api`

## README

# `@gitbook/api`

Javascript (浏览器和节点) API 客户端 [GitBook API 密码](https://developer.gitbook.com/)。 。 。 .

## 安装

```
npm install @gitbook/api
```

## 使用量

```ts
import { GitBookAPI } from '@gitbook/api';

const gitbook = new GitBookAPI({
    authToken: 'gb_abc,
});

const { data } = await gitbook..spaces.getSpaceById('abc');
```

## 常见问题

### @gitbook/api 是什么？

Javascript \(浏览器和节点\) API 客户端 GitBook API 密码。 。 。 \.

### 如何安装 @gitbook/api？

在项目目录运行 npm install @gitbook/api，或使用 pnpm add / yarn add / bun add。

### @gitbook/api 支持 TypeScript 吗？

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

### @gitbook/api 支持 ESM 还是 CommonJS？

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

### @gitbook/api 可以商用吗？

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

### @gitbook/api 的下载量有多少？

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

### @gitbook/api 还在维护吗？

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

