npm 包 jenkins-json 使用教程-JavaScript中文网-JavaScript教程资源分享门户

前言

在前端开发中，我们经常需要在对接不同的后端服务时使用 Jenkins。Jenkins 是一个强大的自动化部署工具，可以通过调用 API 获取构建状态、构建日志等信息。而 jenkins-json 就是一款方便易用的 npm 包，它可以将 Jenkins 获取到的 JSON 数据进行解析和处理，使得数据的呈现更加友好和直观。

本文将详细介绍 jenkins-json 的安装和使用方法，包括如何获取 Jenkins 的 API URL、如何解析和处理 API 返回的 JSON 数据，并配有示例代码，以便读者更好地理解和使用。

jenkins-json 的安装和使用

1. 安装 jenkins-json

在 CMD 或终端中输入以下命令即可安装 jenkins-json：

npm i jenkins-json

安装完成后，我们就可以在自己的项目中使用了。

2. 获取 Jenkins 的 API URL

首先，我们需要获取 Jenkins 的 API URL。在 Jenkins 控制台中，找到对应的 job（如图 1 所示）：

然后，在该 job 的页面中找到「执行此构建」链接（如图 2 所示）：

点击后，会弹出一个新页面。在该页面的浏览器地址栏中，即可找到该 job 的 API URL（如图 3 所示）：

3. 解析和处理 JSON 数据

我们可以利用 jenkins-json 中的函数对 Jenkins API 返回的 JSON 数据进行解析和处理。以下是一些常用的函数：

1. `parseJSON(jsonString: string)`

该函数用于将一个字符串类型的 JSON 数据解析为 JavaScript 的对象类型。

示例代码如下：

-- -------------------- ---- -------
------ - --------- - ---- ---------------

----- ---------- - --
  --------- ----------
  ------------ -
    -
      ----------- ------------
      --------------- ------------
      -------------- ------------
      ----------- ----
    -
  -
---

----- ---- - ----------------------
------------------

输出结果如下：

{
  result: 'SUCCESS',
  artifacts: [ { fileName: 'test.html', relativePath: 'test.html', displayPath: 'test.html', fileSize: 1024 } ]
}

2. `getArtifactUrl(json: any, file: string)`

该函数用于根据文件名获取 Jenkins 视图中「文件下载」链接的地址。

示例代码如下：

-- -------------------- ---- -------
------ - ---------- -------------- - ---- ---------------

----- ---------- - --
  --------- ----------
  ------------ -
    -
      ----------- ------------
      --------------- ------------
      -------------- ------------
      ----------- ----
    -
  -
---

----- ---- - ----------------------
----- ----------- - -------------------- -------------
-------------------------

输出结果如下：

http://jenkins.com/job/myjob/1/artifact/path/to/test.html

总结

本文介绍了 jenkins-json 的安装和使用方法，并详细讲解了如何获取 Jenkins 的 API URL 以及如何解析和处理 API 返回的 JSON 数据。通过本文的学习，读者可以更好地利用 Jenkins 进行自动化部署和开发，提高工作效率。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/60055fe781e8991b448dd8aa

npm 包 jenkins-json 使用教程

前言