配置API节点

操作步骤

1. 新建弹窗界面选择了API节点类型之后，显示API的基本信息配置模板：

  • 认证方式：该节点下所有API实体的认证方式，可选无和Basic auth

    • 选择Basic auth，需要填写用户名和密码

    • 选择为“无”，可以根据API的认证方式要求在Header、UrlParam中依次填写其认证方式所需信息，或通过引用其他数据库表或API接口的方式来获取认证所需Token。

2. 填写完基础配置信息，点击「保存」后将自动跳转到节点详情页。在节点详情页您可以完成动态参数配置、连接配置以及状态码处理策略配置

  • 动态参数配置：

    • 系统支持使用参数来定义动态URL，您可以通过外部赋值的方式来定义参数，在添加API实体时可以在URL、Params、Headers、Body里引用参数，引用时需要用 "[$""]" 将参数转义，例如：参数名称为time的参数在value里引用时需要输入[$time]。

    • 点击添加参数，需要填写参数名称、参数定义、参数类型

      • 参数名称：必填项，不允许重名

      • 参数定义：必选项，可以选择节点赋值

        • 节点赋值：

          • 您可以采用系统内的某个RDBMS数据节点的某张表的第一行的某个字段来定义参数，也可以采用API节点中某个API实体的返回值的某个字段来定义参数。

          • 选择节点赋值后需要赋值的节点的库、表以及字段

      • 参数类型：必选项，可以选择字符串

  • 连接配置：

    • 在连接配置的模块，您可以添加API实体，这些API实体在数据映射和数据任务的配置中相当于其他数据库中表的作用

    • 点击添加API，需要填写连接到API实体的相关配置：

      • API名称：必填项，同一个API节点中的API名称不允许重名

      • URL：必填项，连接到API的URL

        • 您可以用系统内置表达式来定义URL

          • 目前支持表达式： · [$NEXT_PAGE]，用于定义相关分页参数，使用该表达式后该值每次调用完将按自增1的顺序递加。

      • 请求方式：必填项，系统支持GET、POST、PUT

      • params：

        • 您可以按照自己的API文档配置需要调用的参数及对应的值

        • 您可以引用自定义参数来定义Value，也可以用系统内置表达式来定义Value。

          • 目前支持表达式： · [$NEXT_PAGE]，用于定义相关分页参数，使用该表达式后该值每次调用完将按自增1的顺序递加。

      • Headers：

        • 您可以按照自己的需求用KEY/VALUE的方式配置Headers

        • 您可以引用自定义参数来定义Value，也可以用系统内置表达式来定义Value。

          • 目前支持表达式： · [$NEXT_PAGE]，用于定义相关分页参数，使用该表达式后该值每次调用完将按自增1的顺序递加。

      • Body：

        • 您可以用raw的形式自定义API返回Body，如需使用其他媒体格式，在header中指定Content-Type。

        • 您可以用系统内置表达式来定义Body

          • 目前支持表达式： · [$NEXT_PAGE]，用于定义相关分页参数，使用该表达式后该值每次调用完将按自增1的顺序递加。

      • 返回格式：该API请求的返回格式，支持选择json、xml、text

        • 选择json：

          • 编码格式：指样例文件的编码格式以及解析API返回json的编码格式，当API返回编码方式缺省时使用的默认编码格式。

          • 样例文件：您需要上传一个符合系统提供的“json返回格式设计规范”的样例文件，该格式将会用于解析该条API实体的每一条返回数据，点击“下载json返回格式设计规范”可以下载示例文件。

          • 返回数组路径：非必填项，如果返回的数据为数组，您需要填写该数组路径，会将API返回数据拆分为多条数据，并解析数组下的字段。否则将无法解析到该数组下的字段

        • 选择xml：

          • 编码格式：指样例文件的编码格式以及解析API返回xml的编码格式，当API返回编码方式缺省时使用的默认编码格式。

          • 样例文件：您需要上传一个符合系统提供的“xml返回格式设计规范”的样例文件，该格式将会用于解析该条API实体的每一条返回数据，点击“下载xml返回格式设计规范”可以下载示例文件。

          • 返回数组路径：非必填项，如果您的返回数据中有多个数组中有需要的数据，您需要填写该数组路径，否则将无法解析到该数组下的字段

        • 注意：目前返回格式为json、xml类型，系统只解析按照系统提供的json、xml返回格式设计规范的API实体，否则将会出现解析失败的情况。如果您的返回格式不符合系统提供的“json返回格式设计规范”系统提供的“json返回格式设计规范”，建议您选择text格式，在数据链路的表映射模块通过高级清洗来定义具体字段解析逻辑。

      • 最小请求间隔：您可以选择开启或关闭该策略，默认为关闭。系统默认会在得到上一次请求结果后就开始下一次请求，开启最小请求间隔后，如果得到上一次请求结果后未到最小请求间隔，待达到最小请求间隔后再次请求。

    • 当该API实体被链路引用时，无法删除该API实体

    • 当该API实体被非暂停状态的任务引用时，无法编辑该API实体。

  • 状态码处理策略：

    • 您可以通过状态码处理策略配置对于API返回的不同的状态码，数据任务的处理策略。系统支持RESTful API所支持常用状态码，您也可以添加自定义的状态码。

    • 是否写入该条数据：当API请求返回到该状态码后，该条数据是否将会被写入到目的地。可选择是或否

    • 是否暂停任务：当API请求返回到该状态码后，该实体对应的数据任务进行的状态变更。可选暂停任务并报错、继续任务以及继续任务并结束当前批次

      • 继续任务并结束当前批次：结束当前批次，待下一批次的开启后重新开始读取。

    • 系统默认提供三个状态码：200、404、其他

      • 可以修改默认状态码的策略，无法删除该状态码或编辑该状态码的名称

      • 其他：代表除了该列表定义的状态码以外的所有状态码的处理策略

上一页配置 SFTP 节点下一页配置MongoDB节点

最后更新于

这有帮助吗？