简介
mozaik-ext-bamboo-rest-api 是一个基于 Node.js 的 npm 包,可以用于在 Mozaik 仪表盘中显示 Bamboo 的 REST API 数据。
Bamboo 是一个由 Atlassian 公司提供的持续集成和持续部署工具,提供 REST API 接口获取数据。
安装
使用 npm 命令安装:
npm install mozaik-ext-bamboo-rest-api
使用
1. 引入模块
在项目中引入模块:
const { Registry } = require('mozaik/dist/lib/registry') const { BambooMetrics } = require('mozaik-ext-bamboo-rest-api')
2. 注册指标
使用 Registry
注册组件,要在 api/methods.js
中注册所需的指标:
registry.registerApi('bamboo', new BambooMetrics())
3. 更新配置
更新 config.js 配置文件:
-- -------------------- ---- ------- -------------- - - -- --- ---- - ------- - -------- --------------------------------------------- --------- ----------- --------- ---------- - -- -- --- -
其中 baseURL 为 Bamboo 服务器的 REST API 地址,username 和 password 为 Bamboo 账号密码。
4. 展示指标
在 Dashboard 页面上展示该指标,例如在 Dashboard.jsx
中添加以下代码:
<Mozaik.Component.Metrics {...this.props} columns={2} metrics={[ { type: 'bamboo.builds', planKey: 'PLAN-KEY-1', title: 'Build History' }, { type: 'bamboo.builds', planKey: 'PLAN-KEY-2', title: 'Build History' } ]} />
其中 type
为指标名称,planKey
为 Bamboo 中计划的关键字,title
为 Dashboard 页面中指标块的标题。
总结
通过本文的学习,你已经可以使用 mozaik-ext-bamboo-rest-api 这个 npm 包在 Mozaik 仪表盘中展示 Bamboo 的 REST API 数据。
同时,你也可以通过阅读源代码,学习更多 Node.js 开发技巧和项目实战经验。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005609e81e8991b448dedda