Karate处理复杂GET参数，含日期范围教程

理解GET请求与复杂参数结构

在进行API测试时，GET请求通常通过URL中的查询字符串传递参数。标准的查询参数格式为key=value，多个参数之间用&连接。然而，在某些API设计中，为了表示嵌套或数组结构，参数名可能会包含特殊字符，例如方括号[]，如filters[start_date]=...。这种结构在后端解析时通常会被识别为具有特定层级关系的参数。

在Karate中，如果直接尝试使用JavaScript对象字面量来定义包含方括号的参数，例如：

* def query = {id: 60, filters[start_date]:'Fri%20Nov%2018%202022%2010:14:59%20GMT-0300', filters[end_date]:'Sat%20Nov%2019%202022%2023:59:59%20GMT-0300'}
* url 'https://urlbase/index'
* params query
* method get

Karate默认会将整个filters对象编码为一个单一的参数，导致最终生成的URL可能类似于https://urlbase/index?id=60&filters=%7Bstart_date%3D%2C+end_date%3D%7D。这显然不是我们期望的filters[start_date]=...&filters[end_date]=...形式，从而导致后端无法正确解析参数。

Karate中的解决方案：使用 * param

Karate提供了一个专门用于处理URL查询参数的关键字* param。通过为每个查询参数单独使用* param，Karate能够正确地识别带有方括号的参数名，并将其编码为符合URL规范的格式。

以下是使用* param构建包含日期范围和方括号参数的GET请求的示例：

Feature: Test GET request with complex parameters

  Scenario: Send GET request with bracketed date range parameters
    * 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] = 'Fri Nov 18 2022 10:14:59 GMT-0300'：添加一个名为filters[start_date]的查询参数，其值为指定的日期字符串。
• * param filters[end_date] = 'Sat Nov 19 2022 23:59:59 GMT-0300'：添加另一个名为filters[end_date]的查询参数，值为另一个日期字符串。
• * method get：执行GET请求。

通过这种方式，Karate会负责将参数名和参数值进行正确的URL编码，并构建出符合预期的URL。

验证请求与响应

执行上述Karate测试后，我们可以检查httpbin.org返回的响应，以确认URL是否正确构建以及参数是否被正确接收。在response中，你会看到类似以下结构的内容：

{
  "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"
  },
  // ... 其他响应信息 ...
  "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字段：清晰地列出了所有接收到的查询参数及其值，其中filters[start_date]和filters[end_date]被正确识别和解析。
• url字段：显示了Karate实际发送的完整URL，其中方括号[和]以及日期字符串中的空格和冒号都被正确地进行了URL编码（例如，空格变为+，冒号变为%3A）。这正是我们期望的格式。

注意事项与最佳实践

1. 自动URL编码： 使用* param的好处之一是Karate会自动处理参数名和参数值的URL编码。这意味着你无需手动对日期字符串中的空格、特殊字符或方括号进行编码，Karate会替你完成。
2. 日期格式一致性： 传递的日期字符串格式（例如Fri Nov 18 2022 10:14:59 GMT-0300）必须与后端API期望的格式完全一致。如果后端要求ISO 8601格式或其他特定格式，你需要确保提供的日期字符串符合该要求。
3. 动态日期生成： 在实际测试中，日期范围通常需要是动态的（例如，当前日期或未来/过去的某个日期）。你可以结合Karate的JavaScript表达式或自定义函数来生成这些动态日期：

   * def startDate = karate.call('classpath:utils/date_generator.js', { daysAgo: 7 })
   * def endDate = karate.call('classpath:utils/date_generator.js', { daysAhead: 0 })
   * param filters[start_date] = startDate
   * param filters[end_date] = endDate

   其中date_generator.js可以是一个返回格式化日期字符串的JavaScript文件。

4. 避免手动拼接URL： 尽管可以直接在* url中手动拼接查询字符串，但强烈建议使用* param。* param不仅提高了代码的可读性，更重要的是它能够可靠地处理URL编码，避免因编码错误导致的问题。

总结

在Karate框架中处理带有方括号的复杂GET请求参数，特别是日期范围参数时，最健壮和推荐的方法是使用* param关键字为每个参数单独赋值。这种方法不仅能够确保参数被正确地编码和传递，还能提高测试脚本的可读性和维护性。通过结合httpbin.org等工具验证请求，你可以确保你的Karate测试正在以预期的方式与API进行交互。