# @capibox/api-types 中文文档

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

版本：0\.9\.1
npm 元数据更新时间：2026-10-22T10:59:01.767Z
中文译文更新时间：2026-11-09T07:29:10.777Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：2.3 MB，4 个文件
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-08-27T07:26:24.503Z
- 最新版本发布：2026-10-22T10:59:01.560Z
- 近 30 天下载量：4138（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 10 个）

## 中文简介

用于 Capibox 桥接 SDK 包的共享 OpenAPI 生成类型

## 安装

```sh
npm install @capibox/api-types
```

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

## README

# @ capibox/ api 类型

OpenAPI 生成的类型 `bridge-server-sdk`, (中文(简体) ), `bridge-server`, (中文(简体) ), `bridge-browser` 财务报告和审定财务报表 `bridge-nextjs-client`。没有运行时代码,只有类型.

## 重新生成

```bash
pnpm --filter @capibox/api-types run generate
```

这个运行 `openapi-typescript` 与生产规格相对应(`https://api.capibox.com/swagger/json`)和覆盖 `src/api.def.ts`。提交 diff 并附带一个更改器(参见 root README),这样依赖的软件包就会得到一个版本的凸起 .

要针对本地后端生成, 运行 `openapi-typescript` 直接使用自己的 URL :

```bash
npx openapi-typescript http://localhost:4000/swagger/json -o ./src/api.def.ts
```

## 常见问题

### @capibox/api-types 是什么？

用于 Capibox 桥接 SDK 包的共享 OpenAPI 生成类型

### 如何安装 @capibox/api-types？

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

### @capibox/api-types 支持 TypeScript 吗？

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

### @capibox/api-types 可以商用吗？

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

### @capibox/api-types 的下载量有多少？

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

### @capibox/api-types 还在维护吗？

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