前提条件#
已安装并运行 Jenkins（建议 v2.0 或更高版本）
Jenkins 主机上已安装 Node.js v16 或更高版本
安装 Jenkins#
Jenkins 是一款自动化构建工具，可帮助开发者在软件开发过程中自动执行构建、测试和部署应用程序。以下是在 Linux 系统上安装 Jenkins 的方法：2.
将 Jenkins 源添加到 APT 软件源列表：
http://localhost:8080 或 http://{your_public_IP}:8080 访问 Jenkins 控制面板。控制台提供 Web API，供你管理和配置 Jenkins 服务。为 Jenkins 配置 Node.js 环境#
在运行 Apidog CLI 之前，你需要确保 Node.js 版本号为 v16 或更高版本，因此需要先在 Jenkins 环境中配置 NodeJS 依赖。
1.
打开 Jenkins 插件管理，找到 NodeJS 插件，安装并重启。
2.
在全局工具配置中创建新的 NodeJS，配置版本号（要求 v16 或更高版本）和包名 apidog-cli。
1.
在可视化流水线（Freestyle Project）中添加配置
运行 CLI 命令#
可视化配置流水线#
打开 Apidog，并从持续集成详情页面获取 CLI 命令。如果你的 Jenkins 环境可以访问互联网，可以选择使用“实时运行在线数据”命令。如果无法访问互联网，则需要先将 CLI JSON 数据文件导出到环境中，然后通过 CLI 执行。在项目配置页面中，找到 Build Environment 部分，勾选 "Provide Node & npm bin/ folder to PATH" 选项，并选择你在 Global Tool Configuration (Tools) 部分中配置的 NodeJS 版本（例如 nodejs18）。设置构建环境后，进入 Build Steps 部分，点击 Add build step，并选择 Execute Shell（如果你使用的是 Windows 系统，请选择 Execute Windows Batch Command）。将 Apidog CLI 命令粘贴到 Command 输入框中并保存配置。你可以在 “Build History” 中查看构建进度和结果。将嵌入代码集成到流水线#
导航到 CI/CD 选项卡并复制嵌入代码片段，然后将其粘贴到你的 Jenkins 配置文件中。只需将代码直接粘贴到 Jenkins 流水线配置中，即可将其嵌入到你现有的 CI/CD 工作流中。此处提到的 nodejs18 指的是之前设置的 NodeJS 别名——请将其替换为你的实际别名。此外，请确保将代码中的变量 $APIDOG_ACCESS_TOKEN 替换为你的实际访问令牌。或者，你也可以在 Jenkins 的 Dashboard → Manage Jenkins → System 下添加名为 APIDOG_ACCESS_TOKEN 的环境变量，并将其值设置为你的访问令牌。这样流水线就可以在执行期间读取你的访问令牌。你可以通过移除用于安装 Apidog CLI 的脚本来简化上述代码。这样，每次执行构建时就无需重新安装 apidog-cli，从而减少构建时间和资源消耗。这是可行的，因为 NodeJS 和全局 npm 包（即 apidog-cli）已提前在 Global Tool Configuration (Tools) 下配置好，确保构建过程中所需工具可随时使用。使用 Jenkins 发布报告#
在命令中指定生成的报告名称 ${JOB_NAME}_${BUILD_NUMBER}（Jenkins 内置变量）。使用 HTML Publisher 插件查看报告。