配置API输出组件

API输出组件可以将外部数据库中读取的数据写入到API,或从大数据平台对接的存储系统中将数据复制推送至API,进行数据整合和再加工。本文为您介绍如何配置API输出组件。

前提条件

  • 已创建API数据源。具体操作,请参见创建API数据源

  • 进行API输出属性配置的账号,需具备该数据源的同步写权限。如果没有权限,则需要申请数据源权限。具体操作,请参见申请数据源权限

操作步骤

  1. 在Dataphin首页顶部菜单栏,选择研发 > 数据集成

  2. 在集成页面顶部菜单栏选择项目(Dev-Prod模式需要选择环境)。

  3. 在左侧导航栏中单击离线集成,在离线集成列表中单击需要开发的离线管道,打开该离线管道的配置页面。

  4. 单击页面右上角的组件库,打开组件库面板。

  5. 组件库面板左侧导航栏中需选择输出,在右侧的输出组件列表中找到API组件,并拖动该组件至画布。

  6. 单击并拖动目标输入组件的image图标,将其连接至当前API输出组件上。

  7. 单击API输出组件卡片中的image图标,打开API输出配置对话框。image

    参数

    描述

    步骤名称

    即API输出组件的名称。Dataphin自动生成步骤名称,您也可以根据业务场景修改。命名规则如下:

    • 只能包含中文、英文、下划线(_)、数字。

    • 长度不超过64个字符。

    数据源

    在数据源下拉列表中,展示所有API类型的数据源,包括您已拥有同步写权限的数据源和没有同步写权限的数据源。

    • 对于没有同步写权限的数据源,您可以单击数据源后的申请,申请数据源的同步写权限。具体操作,请参见申请数据源权限

    • 如果您还没有API类型的数据源,单击dfag新建图标,创建数据源。具体操作,请参见创建API数据源

    请求方式

    按API数据源配置的请求方式显示。

    • POST:可配置ParametersHeadersBody,允许为空。

    • PUT:可配置ParametersHeaders,允许为空。

    请求的数据结构

    请求传递的JSON数据的格式。

    • 单条数据:一次请求只传递一条数据,有几条数据就进行几次请求。

    • 数组数据:一次请求以数组形式传递一批数据,每次传递的数据量为批量条数的值。选择该方式,支持配置批量读取条数。

      • 批量读取条数:一次请求的数据条数。

    URL路径(非必填)

    输入URL中的路径,此处填写的路径参数将会同数据源中配置的URL进行请求URL的拼接。例如,数据源中配置的URL为https://www.aliyun.com,填写的URL路径为/home,则请求URL为https://www.aliyun.com/home

    写入JSON路径(非必填)

    数据写入JSON对象的路径,例如data.result。此处所填写的路径将被系统自动拼接在输出字段名前,作为完整路径写入。

    请求参数

    请求参数框用于构造API请求的参数定义,例如分页页码,需要在ParametersHeaders或者Body中携带。

    • ParametersHeadersBody均支持中文输出。例如,key分页Value500类型String

    • ParametersHeadersBody均支持使用特殊字符。例如,空格、$、+、&等字符。

    • 当请求方式选择为POST时,支持配置Body。输入格式可选择为JSONKey-Value

      • JSON:需要在JSON代码编辑区域输入相应JSON代码。单击image图标,系统将自动格式化(美化)所输入的代码。

      • Key-Value:单击新建,分别输入Key和Value,并选择当前参数的类型。单击image图标保存此参数后,方可再新建下一个参数。

    输入字段

    根据上游组件的输出,为您展示输入字段。

    输出字段

    为您展示输出字段。 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)、分号(;)、点(.)。

        • 列分隔符用于分隔字段名与字段类型,默认英文逗号(,)。

    • 新建输出字段。

      单击+新建输出字段,根据页面提示填写序号字段并选择类型。单击image图标保存当前行,单击image图标删除当前行。

    • 复制上游字段。

      单击复制上游字段,系统将根据上游的字段名自动生成输出字段。

    • 管理输出字段。

      同时您也可以对已添加的字段执行如下操作:

      • 单击操作列下的agag图标,编辑已有的字段。

      • 单击操作列下的agfag图标,删除已有的字段。

    映射关系

    根据上游的输入和目标表的字段,可以手动选择字段映射。映射关系包括同行映射同名映射

    • 同名映射:对字段名称相同的字段进行映射。

    • 同行映射:源表和目标表的字段名称不一致,但字段对应行的数据需要映射。只映射同行的字段。

  8. 单击确认完成API输出组件配置