API输出典型示例

示例数据：dw_comment.xls

2.1 取出数据

使用「数据转换」节点，进入编辑界面后，拖入「DB表输入」算子，使用 SQL 语句取出需要进行 API 输出的数据，如下图所示：

点击预览数据，如下图所示：

2.2 生成JSON格式数据

由于需要API写入的接口数据需要 JSON 格式，所以需要将原先的数据库表形式数据转换成 JSON 格式。

JSON 样式如下：

{
	"fields": {
		"summary": "文档很赞",
		"components": {
			"name": [
				"FR10"
			]
		},
		"customfield_14904": "https://help.fanruan.com/finereport10.0/doc-view-2463.html",
		"description": "根据参数动态显示地图区域"
	}
}

新增 JSON 生成算子，设置输出 JSON 字段名，并进行 JSON 配置。JSON配置详情参见：JSON生成

JSON 嵌套可以使用「子对象」和「子数组」实现，然后选择对应的字段值，如下图所示：

同时可以修改字段类型，如下图所示：

最终 JSON 生成设置效果如下图所示：

2.3 进行API 输出

新增「API 输出」算子，设置需要将 JSON 写入的 API 配置，body 中可以选择 JSON 格式，并将 JSON 作为 body，如下图所示：

若 API 输出后的接口返回值需要继续使用，可以在返回值处理中勾选「返回响应值至参数」将返回值设置为参数，供后续使用。

设置参数名称并添加默认值便于进行调试。

比如示例接口如果执行成功，会返回{"code":200,"message":"success","self":"http://project.fanruan.com:6023/dataway/service/rest/api/2/issue/804566"}

将其设置为参数，如下图所示：

可在后续节点调用该参数，如下图所示：

• API输出执行状态与 HTTP 响应状态绑定：运行时和预览时只有当响应状态码为2xx时，执行成功，否则报错，错误信息内包含具体的状态码和响应body信息。

• 「返回响应值至参数」选项为复选框，默认不勾选，勾选后用户可以设定参数名与默认值，其中默认值为用户自行从API接口文档内复制粘贴的多行文本。

2.4 运行任务并查看效果

保存并运行任务，任务执行成功后，会通过API输出推送数据至业务系统中，例如生成任务，如下图所示：