用于 JavaScript 的旅 SDK
这是用于JavaScript和TypeScript的旅2相容的SDK.
支持的运行时间
已经非常小心地确保了SDK在最近版本中的工作 节点以及现代浏览器(最新版本的Firefox,Chrome,Edge, Safari等) 如果转写正确 网络软件包 或者说 类似。 。 。 .
安装
使用您最喜欢的软件包管理器安装到您的工程中 .
例如:
$ npm install --save @brigadecore/brigade-sdk
或者说:
$ yarn add @brigadecore/brigade-sdk
基本用途
注意: 所有后面使用 TypeScript 的示例 .
旅API客户端如下:
import { APIClient } from "@brigadecore/brigade-sdk"
// ...
const client = new APIClient(apiAddress, apiToken, opts)
在上述例子中,假定:
apiAddress指向一旅2 API服务器. 地址必须包括: 协议(即必须使用http://或者说https://) (中文(简体) ).apiToken为:- 有效的 API 令牌 。 最好使用非过期服务 账户代号。 请参看旅本身关于如何获得此类物品的文件 一个标志.
- 空字符串是可以接受的, 但只有 API 操作 没有 需求 然后由客户端支持授权.
opts正如人们可能推断的那样,这是一个可选参数。 如果包括的话,必须是 对象,可能有一个单字段allowInsecureConnections包含 值true或者说false以显示是否容忍 SSL 错误 由委托人。 如果没有指定, SSL 错误将 没有 被宽容。 这个 选项仅适用于该选项的值apiAddress参数使用https://作为计划.
这个 client 从呼叫返回到 new APIClient(...) 构造器是
在更专业的客户端树上.
为与旅的“核心”部分合作获得客户(项目, 事件等:
const coreClient = client.core()
这个 coreClient 允许向更专业的客户端导航
示例:
const projectsClient = coreClient.projects()
如果您的程序需要与 旅 的特定子集进行交互 API,可以并鼓励直接即时处理 需要客户端树的子集.
例如,这个例子显示 仅限 事件客户端 - 可能对于像旅网关这样的方案实用的东西 仅与旅的互动涉及创建新事件:
import { core } from "@brigadecore/brigade-sdk"
// ...
const eventsClient = new core.EventsClient(apiAddress, apiToken, opts)
上述论点与我们最初的例子相同.
进一步实例
工作节点和基于浏览器的示例可在 实例 目录.
捐款
旅项目通过GitHub拉取请求接受捐款. 这个 捐款 文档概述了帮助获取 已接受捐款.
支持反馈( R)
我们有一个松懈的频道! 库伯内特斯/ # brigade 随便吧 我们乐于提供帮助。 报告 问题或请求一个特征的问题 这里
行为守则
参加该旅项目受 CNCF 行为守则。 。 。 .