1. 概述
循环API可以实现循环调用API接口,主要使用场景如下:
- API之间传递数据,详情见API之间如何传递数据
- 把ETL处理好的数据,循环推送给API接口
- 循环分页取数,详情见循环分页取数
2. 功能入口
从“添加节点”面板上,把“循环API”拖入到画布中。
3. 参数设置
循环API节点有两个配置,一个循环配置,一个API配置
3.1 循环配置
循环配置中,有两种循环方式:按上游数据循环,按序号循环
按上游数据循环
主要是解决把ETL处理好的数据,循环推送给API接口这个场景。
根据上游数据,一条数据循环一次,循环完所有数据后,退出循环。
循环间隔时间: 是每循环一次,间隔多长时间,在循环下一次,单位是毫秒,默认是0
是否输出映射参数:如果勾选这个选项,就会把映射参数在节点结果中输出,方便跟api响应对应起来
上游数据映射为参数:把上游数据各个字段映射为参数,然后通过参数传给API接口
按序号循环
主要是解决循环分页取数场景,详情见循环分页取数
每循环一次,序号根据提供递增值进行递增,循环到满足退出条件,便退出循环。注:按序号循环,必须配置退出条件,防止无限循环。
序号起始值:这个可以设置页数起始值,默认是1
序号递增:就是每循环一次,序号增加值,默认是1
序号映射参数名:是把序号映射成参数,通过参数把序号传给API,一般这个参数传给API的pageIndex参数
上游数据映射为参数:把上游数据各个字段映射为参数,然后通过参数传给API接口,注:按序号循环这种方式,如果上游数据有多行,只取第一行作为每次循环的参数数据。
退出条件:这里退出条件逻辑运算只支持or方式,即只要满足任意一条,便退出循环。
目前支持条件类型有5种:
循环次数:可以设置循环多少次之后退出循环
响应码:接口返回响应码,正常返回的响应码是200,可以设置数值比较条件判断是否退出循环
Response JSON:接口返回响应内容为JSON数据结构时,才可以选择。通过设置JSONPath(详情见JSONPath 表达式) 表达式提取JSON内容,再根据设置的比较条件判断是否退出循环
Response XML:接口返回响应内容为XML数据结构时,才可以选择。通过设置XPath表达式提取XML内容,再根据设置的比较条件判断是否退出循环
Response Text:把响应内容作为文本,根据设置的比较条件判断是否退出循环
3.2 API配置
API配置跟API取数的配置一样,主要不一样的地方,是这里的参数还可以来源于循环配置中映射的参数。
比如按序号循环方式,loopIndex 是序号映射的参数,access_token是上游数据映射参数。