# @bitbar/cloud-api-client 中文文档

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

版本：1\.7\.7
npm 元数据更新时间：2026-10-29T16:04:07.568Z
中文译文更新时间：2026-11-08T04:46:08.906Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：629 kB，152 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2020-01-10T13:26:41.097Z
- 最新版本发布：2026-10-29T16:04:05.488Z
- 近 30 天下载量：3606（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：180（近 12 个月 19 个）

## 中文简介

JavaScript 的 Bitbar Cloud API 客户端

## 安装

```sh
npm install @bitbar/cloud-api-client
```

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

## README

# JavaScript 的 Bitbar Cloud API 客户端

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://npmcn.com/package/%40bitbar/cloud-api-client/LICENSE.md) [![Build Status](https://travis-ci.com/bitbar/cloud-api-client-js.svg?branch=master)](https://travis-ci.com/bitbar/cloud-api-client-js)

此寄存器包含官方 [位条云](https://bitbar.com/testing/) JavaScript 的 API 客户端. SmartBear的Bitbar Cloud主机有上百个Android和iOS设备,使用户能够创建和测试高质量的移动应用程序和游戏.

## 开始

### 免责声明

请注意,该项目正在制定之中(版本低于1.0.0)。 因此,并非所有资源都得到落实 和/或测试。 工作资源清单可查阅 [这里](https://npmcn.com/package/%40bitbar/cloud-api-client/WORKING-RESOURCES.md)。 。 。 .

### 先决条件

此软件包正在使用 [UMD 图像](https://github.com/umdjs/umd/blob/master/templates/returnExportsGlobal.js) 模式, 所以这意味着你可以使用它:

-   在节点项目中
    
-   浏览器运行工程
    
    -   没有AMD
    -   带 AMD

### 概念

图书馆的语法受到 [柴会HTTP](https://github.com/chaijs/chai-http) 语法. 理解以下一般概念可以让你快速学习语法

#### 1\. 连锁

库中的大多数方法都是可连锁的. 这意味着你不需要写长代码 比如:

```js
var meRef = apiClient.me();
var projectRef = me.project(1);
var runRef = project.run(2);
```

相反,它旨在以这种方式使用:

```js
apiClient.me().project(1).run(2);
```

#### 2\. 每个URL部分都是方法

示例: API 资源下载带有 ID 运行的设备会话列表 `10` 在带有标识的项目中 `20` 将:

```
GET https://cloud.bitbar.com/api/me/projects/20/runs/10/device-sessions
```

第一部分是 `/me` (单位:千美元)`/api` 不计算,因为它是API存储的"指令". 所以说:

```js
apiClient.me();
```

第二个是 `/projects`,但下一个是ID,所以方法将以单数形式:

```js
apiClient.me().project(20);
```

第三个是 `/runs`,但再次 - 有ID, 所以(再次)单数形式:

```js
apiClient.me().project(20).run(10);
```

最后一个是 `/device-dessions`因为它是 _弹匣_我们需要把它变成 _骆驼 Case_数字 :

```js
apiclient.me().project(20).runs(10).deviceSessions();
```

现在,因为 `GET` 默认方法为 1 英寸 `axios`,那么我们不需要明确设置(但如果需要的话,你可以). 所以,剩下的是寄给:

```js
apiclient.me().project(20).runs(10).deviceSessions().send();
```

#### 3\. 结构

现在你知道如何构建一个链式电话,你可能想要例如设定参数,或者设定要发送的数据. 所有课程都有记录,因此从代码中读取文件应该比较容易.

如果资源链以方法结束 _单数_ (所以在斯瓦格语中,它返回单个对象) 然后它是 [APIR 源码](https://npmcn.com/package/%40bitbar/cloud-api-client/src/APIResource.ts)。这意味着你可以使用所有的方法.

如果资源链以方法结束 _复数_ (所以在斯瓦格语中,它返回列表) 然后它是后代的 [APIList 软件](https://npmcn.com/package/%40bitbar/cloud-api-client/src/APIList.ts)。这意味着你可以使用所有的方法.

两者 `APIResource` 财务报告和审定财务报表 `APIList` 儿童 `APIEntity`。 。 。 .

#### 4\. HTTP方法

HTTP方法也是方法.

-   如果您想要发送请求, 请添加到您的链中 `.get()`。 。 。 .
-   如果您想要发送 POST 请求, 请添加到您的链中 `.post()`。 。 。 .
-   如果您想要发送 DELETE 请求, 请添加到您的链中 `.delete()`。 。 。 .

#### 5\. 发送

方法 `.send()` 正在发送请求并返回 `Promise`有了这种方法,你就可以随意锁链了. 等你准备好了就打电话 `.send()`。 。 。 .

### 使用量

#### 常见JS

```sh
npm install @bitbar/cloud-api-client --save
```

```js
const CloudApiClient = require('@bitbar/cloud-api-client');

const apiClient = new CloudApiClient.API({
  cloudUrl: 'https://cloud.bitbar.com',
  apiKey: 'PASTE_HERE_YOUR_OWN_KEY'
});

apiClient.me().send().then( (resp) => {
  console.log(resp.data);
}).catch( (err) => {
  console.error(err);
});
```

#### AMD (英语)

```js
requirejs(['cloud-api-client'], function (CloudApiClient) {
  var api = new CloudApiClient.API({
    cloudUrl: 'https://cloud.bitbar.com',
    apiKey: 'PASTE_HERE_YOUR_OWN_KEY'
  });
});
```

#### 老学校

```html
<!-- note that this is URL to version 0.8.0 -- please check which version is latest -->
<script src="https://github.com/bitbar/cloud-api-client-js/releases/download/v0.8.0/cloud-api-client.min.js"></script>
```

```js
var api = new CloudApiClient.API({
  cloudUrl: 'https://cloud.bitbar.com',
  apiKey: 'PASTE_HERE_YOUR_OWN_KEY'
});
```

### 实例

将简单示例放在 [示例目录](https://npmcn.com/package/%40bitbar/cloud-api-client/examples/README.md)

### 文档

[https://bitbar.github.io/cloud-api-client-js/ 页面存档备份,存于互联网档案馆](https://bitbar.github.io/cloud-api-client-js/)

## 捐款

### 正在检查代码质量

```sh
npm run lint
```

### 正在测试

```sh
npm run test
```

### 大楼

```sh
npm run build
```

## 作者数

-   **马雷克·西耶罗辛斯基** - 说吧 [马维利克斯](https://github.com/marverix)

另见 [捐助者](https://github.com/bitbar/cloud-api-client-js/contributors) 参与该项目的人.

## 许可证

这个项目根据麻省理工学院许可证颁发——见 [利比里亚](https://npmcn.com/package/%40bitbar/cloud-api-client/LICENSE.md) 详细文件

## 常见问题

### @bitbar/cloud-api-client 是什么？

JavaScript 的 Bitbar Cloud API 客户端

### 如何安装 @bitbar/cloud-api-client？

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

### @bitbar/cloud-api-client 支持 TypeScript 吗？

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

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

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

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

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

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

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

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

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