# @dazl/api-client 中文文档

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

版本：1\.0\.98
npm 元数据更新时间：2026-11-09T07:14:40.939Z
中文译文更新时间：2026-11-11T16:41:38.865Z
软件包许可：UNLICENSED

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

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

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

- 包体积（解压后）：2.9 MB，192 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：0 个
- peer 依赖：zod ^4\.4\.3，kysely \>=0\.27\.0
- 首次发布：2026-07-05T16:06:14.344Z
- 最新版本发布：2026-11-09T07:14:40.758Z
- 近 30 天下载量：36303（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：98（近 12 个月 98 个）

## 中文简介

Dazl API 的 SDK 类型安全, 由 OpenAPI 规格生成

## 安装

```sh
npm install @dazl/api-client
```

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

## README

# Dazl 内部 API 客户端

用于Dazl内部API的Type安全SDK由OpenAPI规格生成.

## 安装

```sh
npm install @dazl/api-client
```

## 使用量

创建客户端实例 `createClient` 并传递给每个API呼叫:

```ts
import { createClient } from '@dazl/api-client/internal/fetch-client';
import { Billing } from '@dazl/api-client/internal';

const client = createClient({
    baseUrl: 'http://api-server-url/private',
    headers: {
        'x-api-key': 'my-secret-api-key',
    },
});

const customerInfoRes = await Billing.getCustomerInfoByDazlId({
    path: { dazlId: 'USER_DAZL_ID' },
    client,
});

if (customerInfoRes.error) {
  throw new Error(customerInfoRes.error.message);
}
const customerInfo = customerInfoRes.data;
```

### 代表用户行事

建议的模式是,与 `x-user-id` 页眉烤入并存储在请求上下文中 :

```ts
// middleware — runs once per request
const userClient = createClient({
    baseUrl: 'http://api-server-url/private',
    headers: {
        'x-api-key': 'my-secret-api-key',
        'x-user-id': context.userId,   // userId from the authenticated request
    },
});
context.apiClient = userClient;

// handler — no need to pass headers each time
const customerInfoRes = await Billing.getCustomerInfoByDazlId({
    path: { dazlId: 'USER_DAZL_ID' },
    client: context.apiClient,
});
```

### 相关文件

其他客户端获取文档可在此找到 : [https://heyapi.dev/openapi-ts/客户端/牵引](https://heyapi.dev/openapi-ts/clients/fetch)

### 主要信件兼容性

生成的 `WorkspaceMailbox`, (中文(简体) ), `ChatInbox`,以及 `MajorConversation` 客户包括添加剂 回复相关性,仅限发送者重试资格/创建,以及 `appendMajorIncoming`生成 与 `npm run update:sdk:local` 从寄存器根。 生成源 `sdk/src/` 为: 与其他API合同一样,建立产出.

部署添加剂迁移和API,先发布重生成的SDK,再更新dazl SDK在部署其呼叫器前依赖. `getWorkspaceMessagingCapabilities` 区分 旧服务器的支持; 失败的检查未知 。 接收答复仍只保留现状. `appendMajorIncoming` 只接受来信箱身份,获取其内容和所有者 ,并保留目的地对话的标题和保留时间戳.

## 常见问题

### @dazl/api-client 是什么？

Dazl API 的 SDK 类型安全, 由 OpenAPI 规格生成

### 如何安装 @dazl/api-client？

在项目目录运行 npm install @dazl/api-client，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（^4\.4\.3）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @dazl/api-client 支持 TypeScript 吗？

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

### @dazl/api-client 支持 ESM 还是 CommonJS？

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

### @dazl/api-client 可以商用吗？

@dazl/api-client 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @dazl/api-client 的下载量有多少？

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

### @dazl/api-client 还在维护吗？

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