测试工作流
步骤测试可用于验证已配置的步骤,并执行任何 READ
或 WRITE
操作。
在为特定操作提供所需的输入后,通过测试操作来验证配置会非常有益,这与 zapier.com 上的主编辑器要求进行步骤测试类似。虽然通过此 API 不强制要求测试,但它在以下场景中特别有用:
- 当您的用例中存在常见的配置难题时。
- 以降低用户在创建工作流时出错的风险。
1. 为特定操作提供所有必要的输入
按照 构建 Zap 中的步骤,获取所有必要的输入和认证。
2. 执行测试
通过 /test 端点,发送请求时提供所有必要的 inputs
以及 authentication
(如果不需要,则为 null
)。
例如,对于 ID 为 core:wJ3PxHpNArZ8MqvloW3L1ZyMDQ4nJ
的认证操作,我们可能会发出以下请求:
请求
成功的测试响应
成功的测试响应(无结果)
失败的测试响应
//POST /actions/core:wJ3PxHpNArZ8MqvloW3L1ZyMDQ4nJ/test
"data": {
"authentication": "KrG4mmZs",
"inputs" : {
"channel": "G45J5309P",
"text": ":rotating_light: THIS IS A TEST :rotating_light:",
"as_bot": "yes",
"username": "Step Test",
"icon": ":robot:"
}
}
请注意,如果测试成功,返回的 data
对象直接来自第三方应用,因此没有定义的模式。
3. 清理测试中创建的任何资源
如果可能,在测试成功后清理任何创建的资源。请记住,测试会实际执行操作,因此这些资源可能会在测试后被用户发现,从而引起混淆。