Karate框架中构建包含复杂嵌套参数的GET请求指南

1. 理解问题：GET请求中的复杂参数

在进行api测试时，我们经常会遇到需要向get请求发送包含特殊字符（如方括号[]）的参数的情况，例如filters[start_date]和filters[end_date]。这些参数通常用于表示嵌套结构或数组，在url中会以key[subkey]=value的形式出现。

然而，在Karate框架中，如果尝试通过定义一个包含此类键的JSON对象来构建查询参数，可能会遇到预期之外的行为。例如，以下定义方式：

* def query = {id: 60, 'filters[start_date]':'Fri Nov 18 2022 10:14:59 GMT-0300', 'filters[end_date]':'Sat Nov 19 2022 23:59:59 GMT-0300'}
* url 'https://urlbase/index'
* params query
* method get

当Karate处理params query时，它会将整个query对象视为一个JSON结构进行URL编码。这可能导致生成的URL不是我们期望的key[subkey]=value格式，而是将整个filters部分编码为一个JSON字符串，例如：

https://urlbase/index?id=60&filters=%7Bstart_date%3D%2C+end_date%3D%7D

可以看到，filters后的内容被编码成了%7Bstart_date%3D%2C+end_date%3D%7D，这显然不符合服务器期望的filters[start_date]=...&filters[end_date]=...格式。服务器通常无法正确解析这种编码方式。

2. 解决方案：使用* param关键字

Karate提供了* param关键字，用于显式地向请求URL中添加查询参数。这个关键字能够正确处理包含方括号等特殊字符的参数名，确保它们在URL中保持原样，并自动对参数值进行URL编码。

要实现上述带有日期范围的GET请求，我们可以使用以下方式：

即构数智人

即构数智人是由即构科技推出的AI虚拟数字人视频创作平台，支持数字人形象定制、短视频创作、数字人直播等。

36

查看详情

Feature: Test GET request with complex parameters

  Scenario: Send GET request with filters[start_date] and filters[end_date]
    * url 'https://httpbin.org/anything'
    * param id = 60
    * param filters[start_date] = 'Fri Nov 18 2022 10:14:59 GMT-0300'
    * param filters[end_date] = 'Sat Nov 19 2022 23:59:59 GMT-0300'
    * method get
    * status 200
    * print response

在上面的示例中：

• * url 'https://httpbin.org/anything'：定义了请求的目标URL。httpbin.org/anything是一个非常有用的调试工具，它会返回你发送给它的所有请求信息，方便我们验证请求的正确性。
• * param id = 60：添加一个名为id的查询参数，值为60。
• * param filters[start_date] = '...'：添加一个名为filters[start_date]的查询参数，其值为指定的日期字符串。Karate会自动对日期字符串中的空格、冒号等特殊字符进行URL编码。
• * param filters[end_date] = '...'：同理，添加另一个名为filters[end_date]的查询参数。
• * method get：执行GET请求。
• * status 200：验证响应状态码为200。
• * print response：打印服务器返回的完整响应，以便我们检查请求是否按预期发送。

3. 验证请求的正确性

执行上述Karate测试脚本后，查看控制台输出或response变量的内容。如果请求发送到httpbin.org/anything，你会在响应中找到类似以下结构的信息：

{
  "args": {
    "filters[end_date]": "Sat Nov 19 2022 23:59:59 GMT-0300",
    "filters[start_date]": "Fri Nov 18 2022 10:14:59 GMT-0300",
    "id": "60"
  },
  "data": "",
  "files": {},
  "form": {},
  "headers": {
    "Accept-Encoding": "gzip,deflate",
    "Host": "httpbin.org",
    "User-Agent": "Apache-HttpClient/4.5.13 (Java/17.0.4.1)",
    "X-Amzn-Trace-Id": "Root=1-6377b983-6bfc4696374f7d08239de823"
  },
  "json": null,
  "method": "GET",
  "origin": "X.X.X.X",
  "url": "https://httpbin.org/anything?filters[start_date]=Fri+Nov+18+2022+10%3A14%3A59+GMT-0300&filters[end_date]=Sat+Nov+19+2022+23%3A59%3A59+GMT-0300&id=60"
}

请注意响应中的args字段和url字段：

• "args"：显示了服务器实际接收到的查询参数键值对。可以看到filters[end_date]和filters[start_date]被正确地解析为独立的参数。
• "url"：显示了Karate实际构造并发送的完整URL。它清晰地展示了参数filters[start_date]和filters[end_date]以及它们的值被正确地URL编码并附加到URL中。

这证明了使用* param关键字是处理此类复杂查询参数的正确且有效的方法。

4. 注意事项与总结

• 参数命名灵活性：* param关键字允许你直接使用任何合法的URL参数名，包括带有方括号的名称，而无需担心Karate会将其解析为JSON结构。
• 自动URL编码：* param会自动对参数值进行URL编码，例如将空格编码为+或%20，将冒号编码为%3A，这确保了请求的有效性。
• 避免混合使用：尽量避免将带有方括号的参数名作为JSON对象的一部分传递给params关键字，因为这可能会导致不正确的URL编码。对于这类复杂参数，推荐始终使用* param。
• 动态参数：如果参数值需要动态生成（例如当前日期），你可以结合Karate的JavaScript表达式功能：

  * def startDate = 'some dynamically generated date'
  * param filters[start_date] = startDate

  登录后复制

通过遵循本教程的指导，你将能够有效地在Karate框架中构建和测试包含复杂嵌套参数的GET请求，确保API测试的准确性和健壮性。

以上就是Karate框架中构建包含复杂嵌套参数的GET请求指南的详细内容，更多请关注php中文网其它相关文章！