文档中心HTTP
1. 定义
【HTTP】本质上是支持通过HTTP向指定的API接口中发送数据请求，并获取对方接口返回数据的能力控件。
2. 功能逻辑
【HTTP】节点的本质就是一个HTTP请求，我们通过可配置的面板，将HTTP本身的请求结构拆分为可视化的配置面板。系统在保存节点配置时，会将用户编辑的配置内容拼接起来，作为一个完整的请求存储在后端。 系统在执行【HTTP】节点时，就会把保存的请求取出，并发往指定的接口地址，然后等待接口方接收到请求后返回对应的数据。系统拿到接口返回的数据后，将其存储在流文件中，并其他节点的调用。
3. 配置逻辑
4. 控件栏与画布
【HTTP】是属于控件栏中的「综合」分组下的一个控件。
拖拽控件至画布后，松开鼠标，会生成一个【HTTP】节点，并在右侧弹出属性栏。
5. 属性配置
5.1 基础信息
【HTTP】节点的基础信息配置项与《标准配置·基础信息配置》相同。
5.2 功能配置
功能配置是用于配置【HTTP】具体功能配置的页面区域，一共有以下几个配置项，分别是：请求地址(URL)、请求方法、Headers、Params、内容类型、请求主体、超时时间。
5.3 请求地址(URL)
请求地址是用以填写接口地址(URL)的配置项。 该配置项是一个必填的单行文本组件，点击字段空白处即可开始编写，无其他限制。
5.4 请求方法
请求方法是用来选择标准的HTTP请求方法的配置项。 该配置项是一个必填的单项下拉选择组件，点击字段空白处即可展开下拉列表，下拉列表中一共有2个选项：”POST”、”GET”，其分别表示标准的POST请求方法和GET请求方法。
5.5 请求头(Headers)
Headers是用来配置请求发送时Header信息的配置项，默认打开页面如下
该配置项是一个展开的二级页面，页面主要由7个内容构成：多选框、Key值、赋值方式、Value值、操作栏、提示语句、新增按钮。
多选框
多选框是操作辅助列，无实际业务含义，勾选任意一个或多个选择框，系统则会弹出“批量删除”的提示框，点击即可删除所有选中的行信息。
Key
Key指的是请求的Header信息中的键名。
该配置项是一个必填的单行文本组件，点击字段空白处即可开始编写，无其他限制。
赋值方式
赋值方式指的是该参数的取值方式。
该配置项是一个必填的单项下拉组件，一共有2个可选项，分别是”自定义”和”匹配参数”，默认选项为”自定义”，不可删除，不可修改。
Value
Value指的是请求的Header信息中，键名对应的值。
该配置项是一个非必填的单行文本组件，点击字段空白处即可开始编写，无其他限制。
操作栏
操作栏指的是对当前行的操作交互栏位。
目前，仅支持删除操作，点击删除按钮即可删除当前Value行。
提示语句
提示语句是对当前所有请求头列表配置的信息汇总及提示。
列表为空时不显示提示语句；
列表有选择的变量时，显示文案”已配置了{n}个参数”，n为当前页面表格行数。
新增按钮
新增按钮是可以新增当前页面表格行的操作按钮，点击即可新增一行新的参数配置行。
5.5 请求参数(Params)
Headers是用来配置请求发送时Header信息的配置项，默认打开页面如下
该配置项是一个展开的二级页面，页面主要由7个内容构成：多选框、Key值、赋值方式、Value值、操作栏、提示语句、新增按钮。
多选框
多选框是操作辅助列，无实际业务含义，勾选任意一个或多个选择框，系统则会弹出“批量删除”的提示框，点击即可删除所有选中的行信息。
Key
Key指的是请求的Params信息中的键名。
该配置项是一个必填的单行文本组件，点击字段空白处即可开始编写，无其他限制。
赋值方式
赋值方式指的是该参数的取值方式。
该配置项是一个必填的单项下拉组件，一共有2个可选项，分别是”自定义”和”匹配参数”，默认选项为”自定义”，不可删除，不可修改。
Value
Value指的是请求的Params信息中，键名对应的值。
该配置项是一个非必填的单行文本组件，点击字段空白处即可开始编写，无其他限制。
操作栏
操作栏指的是对当前行的操作交互栏位。
目前，仅支持删除操作，点击删除按钮即可删除当前Value行。
提示语句
提示语句是对当前所有请求参数列表配置的信息汇总及提示。
列表为空时不显示提示语句；
列表有选择的变量时，显示文案”已配置了{n}个参数”，n为当前页面表格行数。
新增按钮
新增按钮是可以新增当前页面表格行的操作按钮，点击即可新增一行新的参数配置行。
5.6 内容类型
内容类型指的是请求主体(Body)的内容类型配置项。 该配置项是一个必填单项下拉选择框组件，列表中目前仅有1个选项”application/json”，默认值为”application/json”，不可删除，不可修改。
5.7 请求主体(Body)
请求主体指的是请求信息里的Body内容配置项。 该配置项是一个非必填的多行文本输入框组件，点击字段空白处即可开始编写，无其他限制。
5.8 超时时间
超时时间指的是请求发起后，数据流等待请求响应的最长时间。
该配置项是一个必填的联合组件，由一个数字输入框与一个单项下拉选择框组件拼接而成。
数字输入框仅允许输入大于0的整数，其他字符在输入时由前端进行阻断；
单项下拉选择框中有2个选项，分别是”秒”和”分钟”。
超时时间的默认值为”60”和”秒”。
超时时间标题旁有一个提示icon，鼠标选题即可显示显示文案：“如果HTTP请求发起以后，数据流在超时时间内未收到响应，则进行报错”。
5.9 轮询
除了以上配置项以外，HTTP还支持对接口进行轮询。
所谓轮询，指的是根据一定规则，周期性地访问某个固定API来获取完整返回数据的方式。
例如，我们向某个API发起查询请求，共查询10,000条订单信息。因为数据量比较大，所以无法通过一次请求获取到完整的数据，我们将请求分为10次，每次拉取1000条信息，这个过程就是轮询。
【HTTP】底部有一些轮询配置项，如图所示。
5.9.1 启用轮询
启用轮询是用于配置当前【HTTP】节点是否向目标接口发起轮询的配置项。
该配置项是一个Switch开关，默认为关闭状态，点击即可在开启和关闭状态中进行切换。
该配置项关闭时，【HTTP】节点不会向目标接口发起轮询；
该配置项开启时，【HTTP】节点会根据用户配置向目标接口发起轮询。
当[启用轮询]的状态为”开启”时，属性栏会新增一些相关配置项，分别是[轮询间隔]和[轮询方式]。
5.9.2 轮询间隔
轮询间隔是用于配置每隔多长时间向目标接口发起请求的配置项。
该配置项是一个必填的组合控件，由一个整数输入控件与一个单项下拉选择控件组成。其中，整数输入控件是提供给用户输入间隔时间数值的，单项下拉选择控件则是提供给用户选择间隔时间单位的，两者组合起来就构成了一个完整的时间间隔配置项。
轮询间隔tootips：支持5秒及5秒以上的轮询间隔
整数输入控件只能输入大于等于1的正整数，不可输入0或负数，默认值为10。
单项下拉选择中共有3个选项，分别是：”秒”、”分钟”、”小时”，默认值为”秒”，仅支持修改，不支持删除。
[轮询间隔]支持的最小间隔为5秒，低于5秒的配置会由系统进行报错，前端显示的错误文案为：
仅支持5秒以上的轮询间隔
5.9.3 业务数据字段
用于获取http请求返回信息中的主体数据，根据业务数据量与单页数据量判断当前http轮询请求是否结束。 tooltips：系统会将返回结果中该参数的值作为数据结果传给后续节点，并以此来判断是否还有未取完的数据，若未找到数据则不轮询。
5.9.4 轮询方式
轮询方式分为“分页轮询”、“偏移量轮询”两种方式，默认为“分页轮询”。两种轮询方式均需要进行具体的轮询参数配置。
5.9.4.1 分页轮询
分页轮询需要配置“分页参数”以及“每次轮询页码增量”。
5.9.4.1.1 分页参数
分页参数：需要定义进行分页轮询时，分页查询的初始页码以及每页查询的数据量。
分页参数字段tootips：分页参数会覆盖掉请求头和请求参数中的同key参数。
点击分页参数下的“编辑”按钮，打开分页参数二级页面，具体配置如下：
分页参数必须配置两行参数-“页码”、“单页数据量”，需要配置对应的参数Key、赋值方式、Value。
**Key：**文本输入框，页码的Key默认值为“pageNum”，单页数据量的Key默认值为“pageSize”。
**赋值方式：**下拉选项，可选择“参数”，“自定义值”，默认为自定义值。
**Value：**组件类型跟随赋值方式改变，“自定义值”的Value组件类型为正整数输入框，“参数”的组件类型为下拉选项，选择当前数据流中可用的参数。
5.9.4.1.2 每次轮询页码增量
每次轮询页码增量，表示在发起分页轮询时，每次调用的请求种页码参数的增量。 每次轮询页码增量：必填，数字输入框，默认值为1，仅支持输入正整数。
5.9.4.2 偏移量轮询
偏移量轮询需要配置偏移量参数，通过点击偏移量参数字段下方的“编辑”按钮可以打开偏移量参数配置的二级页面。
偏移量参数字段tootips：偏移量参数会覆盖掉请求头和请求参数中的同key参数。
偏移量参数需要配置“偏移量”、“数据限制”两行参数对应的Kye、赋值方式、Value。
**Key：**文本输入框，偏移量的Key默认值为“offset”，数据限制的Key默认值为“limit”。
**赋值方式：**下拉选项，可选择“参数”，“自定义值”，默认为自定义值。
**Value：**组件类型跟随赋值方式改变，“自定义值”的Value组件类型为正整数输入框，“参数”的组件类型为下拉选项，选择当前数据流中可用的参数。
执行HTTP轮询时，使用偏移量轮询，每次调用接口查询偏移量后limit数量的数据，例：/posts/?offset=20&limit=5，将获取列表第 20 条后的5条数据。因此根据偏移量轮询的HTTP请求，需要在每次调用时调整offset参数，offset=【在上一次调用的offset】+【limit】。
5.9.5 执行逻辑
同步调用http，轮询生效时，每次轮询产出的主体数据（主体数据字段中返回的业务数据）在一个数据批次中（一个queue）。 根据主体数据字段定义的路径获取数据，判断是否继续轮询。
回到顶部
咨询热线
400-821-9199
