API输出组件可以将外部数据库中读取的数据写入到API,或从大数据平台对接的存储系统中将数据复制推送至API,进行数据整合和再加工。本文为您介绍如何配置API输出组件。
前提条件
操作步骤
请参见离线管道组件开发入口,进入离线管道脚本的开发页面。
按照以下操作指引,进入API输出配置对话框。
单击组件库->单击输出->拖动API输出组件至画布->连接
图标->单击配置
图标
在API输出配置对话框,按照下表配置参数。
参数
说明
步骤名称
即API输出组件的名称。Dataphin自动生成步骤名称,您也可以根据业务场景修改。命名规则如下:
只能包含汉字、字母、下划线(_)、数字。
不能超过64个字符。
数据源
在数据源下拉列表中,展示所有API类型的数据源,包括您已拥有同步写权限的数据源和没有同步写权限的数据源。
请求方式
按API数据源配置的请求方式显示。
POST:可配置Parameters、Headers、Body,允许为空。
PUT:可配置Parameters、Headers,允许为空。
请求参数框用于构造API请求的参数定义,例如分页页码,需要在Parameters或者Body中携带。Parameters和Body支持中文输出。例如,key为
分页
,Value为500
,类型为String
。Parameters、Headers、Body参数配置支持使用特殊字符。例如,空格、$、+、&等字符。请求的数据结构
请求传递的JSON数据的格式。
单条数据:一次请求只传递一条数据,有几条数据就进行几次请求。
数组数据:一次请求以数组形式传递一批数据,每次传递的数据量为批量条数的值。选择该方式,支持配置批量读取条数。
批量读取条数:一次请求的数据条数。
URL路径
非必填,输入URL中的路径,此处填写的路径参数将会同数据源中配置的URL进行请求URL的拼接。例如,数据源中配置的URL为
https://www.aliyun.com
,填写的URL路径为/home
,则请求URL为https://www.aliyun.com/home
。写入JSON路径
非必填,填写JSON路径后可读取数组数据,不填写则读取单条数据。
输入字段
根据上游组件的输出,为您展示输入字段。
输出字段
为您展示输出字段。 Dataphin支持通过批量添加和新建输出字段的方式配置输出字段:
批量添加:单击批量添加,支持JSON、TEXT格式批量配置。
以JSON格式批量配置,例如:
// 示例: [{"name": "user_id","type": "String"}, {"name": "user_name","type": "String"}]
说明name表示引入的字段名称,type表示引入后的字段类型。 例如:
"name":"user_id","type":"String"
表示把字段名为user_id的字段引入,设置字段类型为String。以TEXT格式批量配置,例如:
// 示例: user_id,String user_name,String
行分隔符用于分隔每个字段的信息,默认为换行符(\n),可支持换行符(\n)、分号(;)、点(.)。
列分隔符用于分隔字段名与字段类型,默认英文逗号(,)。
新建输出字段。
单击+新建输出字段,根据页面提示填写字段及选择类型。
复制上游字段。
单击复制上游字段,系统将根据上游的字段名自动生成输出字段。
管理输出字段。
同时您也可以对已添加的字段执行如下操作:
单击操作列下的
图标,编辑已有的字段。
单击操作列下的
图标,删除已有的字段。
映射关系
根据上游的输入和目标表的字段,可以手动选择字段映射。映射关系包括同行映射和同名映射。
同名映射:对字段名称相同的字段进行映射。
同行映射:源表和目标表的字段名称不一致,但字段对应行的数据需要映射。只映射同行的字段。
单击确认,完成API输出组件配置。