JavaScript 的 Bitbar Cloud API 客户端
此寄存器包含官方 位条云 JavaScript 的 API 客户端. SmartBear的Bitbar Cloud主机有上百个Android和iOS设备,使用户能够创建和测试高质量的移动应用程序和游戏.
开始
免责声明
请注意,该项目正在制定之中(版本低于1.0.0)。 因此,并非所有资源都得到落实 和/或测试。 工作资源清单可查阅 这里。 。 。 .
先决条件
此软件包正在使用 UMD 图像 模式, 所以这意味着你可以使用它:
-
在节点项目中
-
浏览器运行工程
- 没有AMD
- 带 AMD
概念
图书馆的语法受到 柴会HTTP 语法. 理解以下一般概念可以让你快速学习语法
1. 连锁
库中的大多数方法都是可连锁的. 这意味着你不需要写长代码 比如:
var meRef = apiClient.me();
var projectRef = me.project(1);
var runRef = project.run(2);
相反,它旨在以这种方式使用:
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存储的"指令". 所以说:
apiClient.me();
第二个是 /projects,但下一个是ID,所以方法将以单数形式:
apiClient.me().project(20);
第三个是 /runs,但再次 - 有ID, 所以(再次)单数形式:
apiClient.me().project(20).run(10);
最后一个是 /device-dessions因为它是 弹匣我们需要把它变成 骆驼 Case数字 :
apiclient.me().project(20).runs(10).deviceSessions();
现在,因为 GET 默认方法为 1 英寸 axios,那么我们不需要明确设置(但如果需要的话,你可以).
所以,剩下的是寄给:
apiclient.me().project(20).runs(10).deviceSessions().send();
3. 结构
现在你知道如何构建一个链式电话,你可能想要例如设定参数,或者设定要发送的数据. 所有课程都有记录,因此从代码中读取文件应该比较容易.
如果资源链以方法结束 单数 (所以在斯瓦格语中,它返回单个对象) 然后它是 APIR 源码。这意味着你可以使用所有的方法.
如果资源链以方法结束 复数 (所以在斯瓦格语中,它返回列表) 然后它是后代的 APIList 软件。这意味着你可以使用所有的方法.
两者 APIResource 财务报告和审定财务报表 APIList 儿童 APIEntity。 。 。 .
4. HTTP方法
HTTP方法也是方法.
- 如果您想要发送请求, 请添加到您的链中
.get()。 。 。 . - 如果您想要发送 POST 请求, 请添加到您的链中
.post()。 。 。 . - 如果您想要发送 DELETE 请求, 请添加到您的链中
.delete()。 。 。 .
5. 发送
方法 .send() 正在发送请求并返回 Promise有了这种方法,你就可以随意锁链了.
等你准备好了就打电话 .send()。 。 。 .
使用量
常见JS
npm install @bitbar/cloud-api-client --save
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 (英语)
requirejs(['cloud-api-client'], function (CloudApiClient) {
var api = new CloudApiClient.API({
cloudUrl: 'https://cloud.bitbar.com',
apiKey: 'PASTE_HERE_YOUR_OWN_KEY'
});
});
老学校
<!-- 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>
var api = new CloudApiClient.API({
cloudUrl: 'https://cloud.bitbar.com',
apiKey: 'PASTE_HERE_YOUR_OWN_KEY'
});
实例
将简单示例放在 示例目录
文档
https://bitbar.github.io/cloud-api-client-js/ 页面存档备份,存于互联网档案馆
捐款
正在检查代码质量
npm run lint
正在测试
npm run test
大楼
npm run build
作者数
- 马雷克·西耶罗辛斯基 - 说吧 马维利克斯
另见 捐助者 参与该项目的人.
许可证
这个项目根据麻省理工学院许可证颁发——见 利比里亚 详细文件