JMeter - 如何测试REST API / 微服务

概述：

有许多方法和工具可用于测试REST API。
当我需要测试REST API时，在查看了各种工具和选项之后，由于以下原因，我选择了JMeter。

JMeter是免费和开源的。
JMeter可以从CSV文件中直接读取您的测试数据。参数化非常简单。
- 可以轻松地使用多组数据测试API。
JMeter有一个功能强大的“ 响应提取器” -可用于从API响应中提取信息（JSON / XML /正则表达式），并在测试的后续请求中使用它。
JMeter有大量的“ 断言 ” - 来验证API响应是否符合预期。
我们为功能测试创建的JMeter测试也可用于性能测试。
ANT / Maven / Gradle插件作为构建的一部分执行测试。
与Jenkins轻松集成以定期运行测试，Jenkins有一个JMeter插件来解析结果文件并显示漂亮的图表。

安装JMeter：

启动JMeter后，您将看到Test Plan 元素，它是JMeter测试的根节点，我们将在其中为测试添加各种JMeter元素。

创建一个简单的API JMeter测试：

现在让我们为测试添加所需的元素。

在测试计划下添加一个线程组。（右键单击测试计划 - >添加 - >线程（用户） - >线程组）
- 我们更新了线程组中的用户数，迭代次数等。
- 现在让他们成为1。

在线程组下添加HTTP请求采样器。（右键单击线程组 - >添加 - >采样器 - > HTTP请求）
- Sampler是一种JMeter请求。
- REST是一种方法，它使用HTTP协议。所以我们添加HTTP Request采样器。
- 将服务器IP /主机名更新为 myapiservername.com [对于此API网址：http： //myapiservername.com/rest/api/path ]
- 更新API路径 / rest / api / path

使用请求发送文件 - 应该具有请求JSON文件的路径，或者在HTTP请求的正文数据部分中包含请求JSON 。

添加 HTTP标头管理器 （右键单击测试计划 - >添加 - >配置元素 - > HTTP标头管理器）
- 名称= apigeekey
- 值=测试@ 123
- 名称=的Content-Type
- 值=应用/ JSON
- 在HTTP Header Manner配置页面中，单击“添加”。
- 包括此名称 - 值对。
- 如果您的API需要APIGEE密钥，请将其包含在此处或忽略。

添加 HTTP授权管理器 -在任何身份验证的情况下都是必需的。（右键单击测试计划 - >添加 - >配置元素 - > HTTP授权管理器）
- 将基本URL更新为 http://myapiservername.com
- 更新用户名
- 更新密码
在“测试计划”下，添加一个侦听器 - “ 查看结果树”

您的JMeter测试将如下所示（我没有包括监听器）。

现在如果你运行它，你应该能够发送请求并成功获得响应。

注意：如果由于某种原因它不起作用，请尝试将HTTP请求实现更改为Java /其他值并尝试一下。

无论我们到目前为止做了什么，都是一个非常简单的测试 - 就像POC一样。现在让我们看看如何进一步改进它。

参数化测试数据：

在上面的示例中，我们发送硬编码请求JSON来测试API。我们可能必须针对不同的数据集测试API。

让我们举一个非常简单的例子，我有一个API，它给出了我发送的图书ID请求的图书名称和价格详细信息。

CSV中的测试数据：

请求JSON：

让我们假设我们的API请求采用以下格式。

{"bookid": 1
}

复制

响应JSON：

让我们假设我们的API响应如下所示。

{"bookname": "Awesome Jmeter""bookprice": 23.5
}

在测试计划下添加CSV数据集配置并更新上面给出的详细信息。

变量名称：可以为空。JMeter将CSV列名称作为变量名称。
回收EOF？：应该是假的。我们只测试每一行一次。
在EOF上停止线程？：应该是TRUE。一旦我们测试了所有行，它将自动停止JMeter测试。
在“线程组”中，选中“循环计数”中的“For Ever”复选框。

参数：

我们不是发送硬编码的书籍ID，而是使用CSV文件的“id”列中的值对其进行参数化。

而已。如果您现在运行测试，它应该为CSV文件中的每一行逐个发送6个请求。

我们可以做得比这更好 - 如果有不同类型的请求 - GET / POST / DELETE / PUT / PATCH等等。使用JMeter非常容易。我完全通过电子表格驱动我的测试，如下所示。请在此处查看JMeter - REST API - 数据驱动测试的高级用法

断言：

如果我们可以发送请求并获得响应，那么我们完成了吗？不！！但是，我们几乎就在那里！

我们需要验证我们是否得到了预期的响应。因此，最后一步是添加断言。

我在上面的示例中显示的CSV文件中有预期的书名和价格详细信息。让我们使用这些细节来检查我们的API是否按预期工作。

在HTTP Request下添加Response Assertion ，如下所示。我们需要验证响应中是否有预期的图书名称和价格。按下面的说明添加它们。

此断言将验证响应并相应地通过/失败测试。（确保模式匹配规则是'包含'，因为我们只检查书名和价格。我们没有验证整个响应。）

持续时间断言：

JMeter不仅验证文本，还验证请求的“ 时间 ”。如果我们添加“持续时间断言”并设置可接受的时间限制，JMeter可以确认是否在时间限制内收到了响应。

从JSON响应中提取数据：

有时，您可能希望从JSON响应中提取特定数据，并将此数据传递给JMeter中的后续请求。JMeter提供了一个JSON Extractor来从JSON响应中提取特定值。

让我们假设，我的样本响应看起来像这样。

{"title":"In Search of Lost Time","author":"Marcel Proust","id":1
}

复制

我可以添加一个JSON Extractor，如下所示，将作者的值提取到变量authorValue中。

$指的是JSON Path表达式中的根元素
'author'是根元素的直接子元素。所以可以使用$ .author访问它
匹配编号给出第N个匹配。如果您想要数组中的所有匹配值，则匹配数字应为-1
默认值 - 在没有匹配时使用

让我们考虑下面的JSON响应

{"store":{"book":[{"category":"reference","author":"Nigel Rees","title":"Sayings of the Century","price":8.95},{"category":"fiction","author":"Evelyn Waugh","title":"Sword of Honour","price":12.99}],"bicycle":{"color":"red","price":19.95}}
}

复制

要获得第一本书的价格 - $ .store.book [1] .price
从类别获得所有价格 - $ ..价格

有关这方面的更多信息，请点击此处。

REST API的性能测试：

您可能已经验证了API功能！

但是，我们如何知道有关API的以下信息？

响应时间
它可以支持的并发用户
用户负载中断
CPU /内存使用情况
内存泄漏

通过使用我们刚刚创建的相同测试，JMeter也可以在这里提供帮助！

更新线程组中的线程数。如果输入10作为用户数并运行，JMeter将模拟10个并发用户。
更新加速期（以秒为单位）。例如：如果您有10个用户和50秒作为加速期，JMeter将每5秒开始创建1个虚拟用户。
循环计数：选择“永远”。
在Scheduler下，输入Duration（秒）。[输入600将对10个虚拟用户进行10分钟的性能测试。]
更新CSV数据集配置：'回收EOF？' - 将其设置为TRUE - [FALSE仅读取一次CSV数据。我们需要足够的数据让VUsers运行10分钟。因此，将其设置为TRUE将在读取后提供相同的测试数据集]
在测试计划下添加“聚合报告”监听器。

立即运行您的仪表测试。“聚合报告”将基本了解您的REST API性能指标，例如在给定持续时间内发出的请求数，平均响应时间，吞吐量，“90％行”等。[注意：运行JMeter性能不是一个好习惯我们刚刚在GUI模式下测试，因为它消耗更多内存。请查看此提示和技巧，了解要遵循的最佳做法。]

摘要：

我们刚刚创建了一个简单的数据驱动框架，用于在不使用任何编程语言的情况下使用JMeter测试REST API的功能行为。我们还看到了如何通过重用为功能测试创建的相同脚本，使用JMeter对我们的API进行性能测试。

您可能希望继续阅读有关JMeter - REST API - 数据驱动测试的高级用法的更多信息

你是JMeter的新手吗？- 然后你应该完全检查这篇文章，它提供了有关JMeter最佳实践和初学者常见错误的更多信息。

Response Assertion can also compare the response code.
But, We will have more control over Beanshell Assertion.

To check the HTTP response code (assuming you have stored the expected response code in CSV in ‘resCode’ column),

if (ResponseCode.equals(vars.get("resCode")) == true && ResponseData.contains(vars.get("expectedMessage")) == true ) {
SampleResult.setResponseOK();
}else{
Failure=true;
FailureMessage="Response code/data not as expected";
}