IRIS API 测试工具快速上手指南：Postman 集合验证实战

一. IRIS API 测试工具简介

IRIS API 测试工具是一个结合了 InterSystems IRIS 与 Newman 的 Docker 项目，旨在为开发者提供快速、简便的方法来测试 Postman 集合。

该工具的核心优势包括：

无需复杂配置即可运行 API 测试。
支持导入 Postman 集合并生成详细测试报告。
可通过界面操作或 API 请求进行测试执行。

本文将详细介绍从环境搭建到测试执行的完整流程，帮助您快速上手。

二. 克隆项目仓库

首先，需要将项目仓库克隆到本地：

git clone https://github.com/daniel-aguilar-garcia/irisapitester.git
cd irisapitester

三. 启动 Docker Compose

进入项目目录后，运行 Docker Compose 文件以启动 IRIS 服务和 Newman 测试环境：

docker-compose up -d

启动完成后，您可以通过 Docker 查看容器状态，确保 IRIS 与测试工具正常运行。

四. 打开测试工具主页

在浏览器中访问以下地址，即可打开 IRIS API 测试工具主页：

http://localhost:52773

主页提供直观的界面，用于上传 Postman 集合、运行测试并查看报告。

五. 为 Postman 集合添加测试

在 Postman 中为您的集合添加测试。常见示例为：

pm.test("状态码为200", function () {
    pm.response.to.have.status(200);
});

您可以选择：

为集合中的所有请求添加全局测试。
为每个请求单独添加特定测试。

这种灵活性确保测试覆盖所有关键 API 场景。

六. 导出 Postman 集合

完成测试配置后，将集合导出为 JSON 格式：

点击 Postman 界面右上角导出按钮。
选择 Collection v2.1 (recommended) 格式。

导出的 JSON 文件将用于 IRIS API 测试工具上传和执行。

七. 上传集合并运行测试

将 JSON 文件拖放到 IRIS API 测试工具主页，然后点击 运行测试。

几秒钟后，工具会生成测试报告，并自动跳转到报告页面，展示所有测试的执行情况和结果。

八. 查看测试报告

测试报告页面提供详细信息：

每个请求的状态码、响应时间和执行结果。
错误和失败请求的详细日志。
支持导出报告为 HTML 格式，方便分享与归档。

通过报告，开发者可以快速定位问题并优化 API 集合。

九. 使用 API 接口运行测试

如果您希望自动化运行测试，无需通过界面，可使用 IRIS API 提供的接口：

1. 执行测试的 POST 请求

POST http://localhost:52773/run_tests
Content-Type: application/json
Body: {
    "collection": "路径/到/集合.json"
}

2. 获取 HTML 报告的 GET 请求

GET http://localhost:52773/show_report

通过 API 调用，您可以将测试集成到 CI/CD 流程，实现持续集成测试。

十. 示例集合文件

为了快速上手，您可以使用提供的示例 Postman 集合 JSON 文件进行测试：

下载并上传至 IRIS API 测试工具。
运行测试，查看报告效果。

该示例涵盖常见 API 场景，适合初学者练习操作。

十一. 总结

IRIS API 测试工具是开发者验证 Postman 集合功能和稳定性的利器。

通过本指南，您可以：

快速搭建测试环境。
轻松导入和运行 Postman 集合。
获取详细的测试报告并进行问题定位。
通过 API 集成实现自动化测试。

这款工具将显著提升 API 测试效率，为开发和运维工作带来便利。

原文链接: https://community.intersystems.com/post/iris-api-tester