使用 Katalon 实现 API Mocking

作者:API传播员 · 2025-12-30 · 阅读时间:5分钟

在进行 API Mocking,可以充分发挥其潜力,为测试过程提供极大的便利。

本文将为您详细介绍如何在 Katalon 中实现 API Mocking,包括从使用 createAPIMockSession 关键字启动 Mock 服务器,到通过 apiMockRule 编写自定义响应的完整步骤。继续阅读,了解如何利用 Katalon 提升您的 API 测试效率。


什么是模拟 API?

模拟 API(Mock API)通过对匹配请求返回真实的响应,模拟实际的 API 行为。它们可以运行在本地计算机、网络计算机或公共互联网上。

模拟 API 的响应通常是静态的,但根据具体场景,也可以是动态的。


为什么需要模拟 API?

在大多数 Web 应用程序或中间件开发中,通常需要集成第三方服务,这些服务依赖于外部 API。然而,在开发过程中,这些 API 可能暂时不可用。此时,Mock API 可以帮助您模拟这些外部依赖,直到实际 API 可用为止。

Mock API 的主要优势包括:

  • 允许 QA 团队在开发生命周期的早期进行测试准备和自动化测试
  • 在实际 API 开发完成之前,为消费者测试或演示提供支持。

Katalon 如何实现 API Mocking?

Katalon Studio 提供了一个插件,用于模拟 API,从而显著提升测试效率。以下是实现 API Mocking 的三个核心关键字:

1. createAPIMockSession

该关键字用于在测试或测试套件开始之前启动 Mock 服务器,并加载所有规则。它通过参数在指定的主机/域和端口上创建一个 API Mock。

参数说明:

  • host(可选):指定主机/域名,默认为 localhost
  • httpPort(可选):指定监听的 HTTP 端口,默认为 8080
  • httpsPort(可选):指定监听的 HTTPS 端口,默认为 443

示例代码:

createAPIMockServer("localhost", 8080);
createAPIMockServer("127.0.0.1", 443);
createAPIMockServer("localhost", 8080, 443);

2. apiMockRule

该关键字用于创建特定的 API 规则,定义匹配请求的条件,并返回特定的响应。

参数说明:

  • httpMethod(可选):指定 HTTP 方法(如 GET、POST、PUT、DELETE)。如果未指定,则为所有方法返回通用响应。
  • urlPath(可选):指定 URL 路径(如 /getNames/deleteCity)。如果未指定,则使用默认主机作为 URL。

3. stopAPIMockSession

该关键字用于在测试运行结束时停止 Mock 服务器。


使用 Katalon 实现 API Mocking 的步骤

步骤 1:安装插件

将 Mock API 的 JAR 文件放置在 Katalon Studio 项目的插件文件夹中,然后重启 Katalon Studio。重启后,您可以在事件日志中看到插件加载成功的提示。

插件安装成功

步骤 2:创建测试用例

为需要测试的 API 创建一个 Katalon Studio 测试用例。

步骤 3:启动 Mock 服务器

在测试用例中,添加自定义关键字 createAPIMockSession,并设置主机、端口和 HTTPS 端口的参数。如果参数留空,将使用默认值。

添加 Mock 服务器

步骤 4:添加 Mock 规则

使用 apiMockRule 关键字为 Mock API 添加多个规则。

添加 Mock 规则

步骤 5:创建 API

根据对象库中的 Mock 规则创建 API,也可以为 API 添加验证规则。

创建 API

步骤 6:调用 API

调用从测试用例中创建的 API,并在最后添加 stopAPIMockSession 关键字以停止 Mock 服务器。

调用 API

步骤 7:运行测试用例

运行测试用例,验证结果是否符合预期。

测试结果


总结

Katalon Studio 为开发人员和 QA 团队提供了强大的 API Mocking 功能。这些功能不仅支持高度定制化和灵活性,还能帮助团队在开发生命周期的早期进行测试,从而加速开发进程并提升软件质量。

通过本文的指南,您可以轻松掌握在 Katalon 中实现 API Mocking 的方法。希望本文对您有所帮助,敬请期待更多实用内容!

原文链接: https://katalon.com/resources-center/blog/api-mocking-with-katalon