# @epilot/document-client 中文文档

规范地址：https://npmcn.com/package/%40epilot/document-client/

版本：0\.21\.0
npm 元数据更新时间：2026-11-10T09:28:26.288Z
中文译文更新时间：2026-11-13T19:42:43.967Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40epilot/document-client
原文对照：https://npmcn.com/package/%40epilot/document-client/?lang=original

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

- 包体积（解压后）：39 kB，10 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：6 个
- peer 依赖：axios ^1\.0\.0 \|\| \>=0\.25\.0 \<1\.0\.0
- 首次发布：2021-11-04T17:28:27.755Z
- 最新版本发布：2026-10-13T11:37:26.143Z
- 近 30 天下载量：9155（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：44（近 12 个月 3 个）

## 中文简介

API 电子驾驶文档 API 客户端

## 安装

```sh
npm install @epilot/document-client
```

也可以使用：`pnpm add @epilot/document-client`、`yarn add @epilot/document-client`、`bun add @epilot/document-client`

## README

# `@epilot/document-client`

API 客户端用于电子驾驶文档 API.

用途 [`openapi-client-axios`](https://github.com/openapistack/openapi-client-axios)

## 开始

安装软件包 :

```bash
npm install --save-dev @epilot/document-client
```

导入软件包 :

```typescript
import { getClient } from '@epilot/document-client';
```

使用客户端 :

```typescript
// get typed client
const client = await getClient();

// call an operation
const res = await client.generateDocument(null, {});
```

## BaseURL 授权( A)

要通过授权头并设置 API url, 您可以使用 arxios 默认 :

```typescript
const client = getClient();
client.defaults.baseURL = config.API_URL;
client.defaults.headers['authorization'] = `Bearer ${token}`;
```

## API 文档 :

[https://docs.api.epilot.io/文档](https://docs.api.epilot.io/document)

## 常见问题

### @epilot/document-client 是什么？

API 电子驾驶文档 API 客户端

### 如何安装 @epilot/document-client？

在项目目录运行 npm install @epilot/document-client，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：axios（^1\.0\.0 \|\| \>=0\.25\.0 \<1\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @epilot/document-client 支持 TypeScript 吗？

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

### @epilot/document-client 支持 ESM 还是 CommonJS？

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

### @epilot/document-client 可以商用吗？

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

### @epilot/document-client 的下载量有多少？

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

### @epilot/document-client 还在维护吗？

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