# @mittwald/api-client-commons 中文文档

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

版本：4\.509\.0
npm 元数据更新时间：2026-11-01T19:09:17.275Z
中文译文更新时间：2026-11-01T22:08:50.467Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40mittwald/api-client-commons
原文对照：https://npmcn.com/package/%40mittwald/api-client-commons/?lang=original
项目主页：https://developer.mittwald.de/
源码仓库：https://github.com/mittwald/api-client-js

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

- 包体积（解压后）：31.5 kB，57 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：@mittwald/react-use-promise ^2\.6\.0 \|\| ^3\.0\.0 \|\| ^4\.0\.0
- 首次发布：2023-06-07T11:56:41.220Z
- 最新版本发布：2026-11-01T19:09:16.927Z
- 已发布版本数：487（近 12 个月 372 个）

## 中文简介

中间件API客户端的常用类型和实用程序

## 安装

```sh
npm install @mittwald/api-client-commons
```

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

## README

使用的公共代码库 `@mittwald/api-client-*` 包中。

## API

### assertStatus, assertOneOfStatus

API客户端不会根据设计验证任何响应状态，从而为您提供 大多数灵活性，同时处理错误的响应。如果你想断言 一些期望的响应状态，可以使用 `assertStatus` 分别地。 `assertOneOfStatus` 函数。

#### expectedStatus assertStatus(响应)

返回:空白

这个方法抛出 `ApiClientError` 如果给定 `response` 不匹配 这个 `expectedStatus`.

当你使用TypeScript时，这个函数也会断言正确的响应 类型。

```ts
const response = await client.project.getProject({
  pathParameters: {
    projectId: "...",
  },
});

assertStatus(response, 200);

const project = response.data;
// Project properties can now be accessed safely
const name = project.name;
```

#### expectedStatus assertOnOfStatus(响应)

返回:空白

这个方法抛出 `ApiClientError` 如果给定 `response` 不匹配 这个 `expectedStatus`.

当你使用TypeScript时，这个函数也会断言正确的响应 类型。

```ts
const response = await client.project.getProject({
  pathParameters: {
    projectId: "...",
  },
});

assertOneOfStatus(response, [200, 404]);

if (!response.data) {
  console.log("Project not found");
}
```

### 常见的拦截器

为了更容易地选择一些API机制，这里有几个 [拦截器](https://axios-http.com/docs/interceptors) 很容易 配置。

#### withAccessToken

在大多数情况下，您希望将用户访问令牌添加到每个API-Request中 请求头。如果你需要自己做这件事，这可能会很乏味。来 自动设置请求头的使用 `withAccessToken` 为你的 `APIClient` 实例。

```ts
const client = new APIClient({ baseURL });
const authenticatedClient = withToken(client, token);
```

#### withEventConsistencyHandling

选择加入 [事件一致性处理](https://developer.mittwald.de/docs/v2/api/intro/#eventual-consistency) 你可以使用 `withEventConsistencyHandling`． 这将设置自动处理 这个 `etag` 响应头，并将其值设置为 `if-event-reached` 请求 GET请求头：

```ts
const client = new APIClient({ baseURL });
const authenticatedClient = withEventConsistencyHandling(client);
```

## 常见问题

### @mittwald/api-client-commons 是什么？

中间件API客户端的常用类型和实用程序

### 如何安装 @mittwald/api-client-commons？

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

### @mittwald/api-client-commons 支持 TypeScript 吗？

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

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

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

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

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

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

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