# @air/api-rest 中文文档

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

版本：0\.12\.0
npm 元数据更新时间：2026-11-05T20:25:02.060Z
中文译文更新时间：2026-11-05T20:57:57.843Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：152 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：1 个
- 首次发布：2026-03-27T16:31:30.487Z
- 最新版本发布：2026-11-05T20:25:01.882Z
- 近 30 天下载量：22895（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

Air API 的 REST 客户端

## 安装

```sh
npm install @air/api-rest
```

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

## README

# @ air/ api-rest (英语)

输入的 REST 客户端 [空中API SDK](https://github.com/AirLabsTeam/air-api-sdk)。 。 。 .

此软件包提供了资源类(板,展示,资产,标签,自定义字段,讨论,成员,上传,导入,角色)及其类型. 其基础是 `@air/api-core` 用于HTTP运输.

## 安装

大多数用户应安装 `@air/api-sdk` 相反,包括这个软件包:

```bash
npm install @air/api-sdk
```

如果您只需要 REST 资源层 :

```bash
npm install @air/api-rest
```

## 包括什么

-   资源类别: `Boards`, (中文(简体) ), `Showcases`, (中文(简体) ), `Assets`, (中文(简体) ), `Tags`, (中文(简体) ), `CustomFields`, (中文(简体) ), `Discussions`, (中文(简体) ), `Members`, (中文(简体) ), `Uploads`, (中文(简体) ), `Imports`, (中文(简体) ), `Roles`
-   讨论: `list`, (中文(简体) ), `get`, (中文(简体) ), `listComments`, (中文(简体) ), `create`, (中文(简体) ), `createComment`, (中文(简体) ), `update`, (中文(简体) ), `updateComment`, (中文(简体) ), `deleteComment`
-   成员: `list`
-   显示大小写 : `list`, (中文(简体) ), `get`, (中文(简体) ), `create`, (中文(简体) ), `update`, (中文(简体) ), `updateShareLink`, (中文(简体) ), `addAssets`, (中文(简体) ), `removeAsset`, (中文(简体) ), `addBoards`, (中文(简体) ), `removeBoard`外加一个 `showcaseId` 打开过滤器 `assets.list` 财务报告和审定财务报表 `boards.list`
-   资产 CDN 链接助手 : `listCdnLinks`, (中文(简体) ), `createCdnLink`,以及 `updateCdnLink`
-   共享链接 : `listShareLinks`, (中文(简体) ), `createShareLink`,以及 `updateShareLink` 资产和董事会
-   所有 API 请求/响应形状的完整类型Script 类型
-   `AirApi` 构成所有资源的客户类

## 文档

-   [空气开发者 Docs](https://developer.air.inc/) API 参考和指南
-   [GitHub 仓库](https://github.com/AirLabsTeam/air-api-sdk) 源代码和示例

## 许可证

麻省理工学院

## 常见问题

### @air/api-rest 是什么？

Air API 的 REST 客户端

### 如何安装 @air/api-rest？

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

### @air/api-rest 支持 TypeScript 吗？

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

### @air/api-rest 支持 ESM 还是 CommonJS？

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

### @air/api-rest 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @air/api-rest 可以商用吗？

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

### @air/api-rest 的下载量有多少？

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

### @air/api-rest 还在维护吗？

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