一、场景介绍
场景1:开发和生产环境的API数据源使用不同的API Key或Token。创建API数据源时,其中有一个场景是生产与开发环境的API数据源的API Key或Token不同,此时在管道输入组件中通过将其添加为参数的方式无法满足该场景下的需求。故需要支持在创建数据源时就进行配置可区分生产或开发环境的API Key或Token。
场景2:创建一个API数据源,配置绝对路径URL,在集成组件中指定相对路径的 URL。在使用到API的常见场景中,在一个相同的绝对路径URL下,不同业务属性的数据会存在多个相对路径不同的URL上,如www.mysite.com/customer、www.mysite.com/order和www.mysite.com/stock等, 且这些数据都需要进行数据集成,此时如需要为每一个URL地址配置一个数据源,就会徒增许多冗余配置操作。如果能在集成组件中配置相对路径,就会提高任务配置的效率。
二、功能升级与优化
1. API数据源认证方式优化
在创建API数据源时,认证方式新增了API Key和Bearer Token,生产和开发数据源可以自由配置不同的认证方式,或者是Key或Token。选择API Key认证方式后,可以选择添加至Parameters、Headers或是Body,可满足不同API数据源认证方式的需求。
2. API集成组件支持配置url相对路径
在API数据源的URL地址配置项中,我们可以仅填写绝对路径,如www.mysite.com。在API集成组件中,有url路径配置项,可填写相对路径,如/custom,该配置项内容将会被拼接在数据源的url地址后,如在这里就会自动拼接成www.mysite.com/custom作为完整的API访问地址。该优化省去了配置多个API数据源的工作量。
3. 新增支持API输出组件
本次升级新增支持了API数据源输出组件,支持将Dataphin或者其他数据源中的数据通过离线集成管道的方式写入到API数据源中。
- 支持Post和Put请求方式:Put被定义为幂等的方法, Post不是幂等的方法。幂等意为每次执行都是同样的效果。Put请求方式,用于向指定的url传送更新资源,是幂等的,例如修改密码,每次提交都只是更新该用户密码,每次请求都只是覆盖原型的值,此时用Put;Post请求方式,可以更新或者创建资源,是非幂等的。例如用户注册时,每次提交都是创建一个用户账号,此时用Post。
- 支持选择请求传递的JSON数据的格式:选择单条数据则一次请求只传递一条数据,有几条数据就进行几次请求;选择多条数据则一次请求以数组形式传递一批数据,每次传递的数据量为批量条数的值。
- 支持配置url相对路径:该配置项内容将会被拼接在数据源的url地址后作为完整的地址。
- 支持配置写入JSON的路径:可选填,写入字段的最外层路径,将被拼接在输出字段名前作为完整路径写入。
- 支持配置输出字段:新建字段的名称表示写入的字段名。例如字段为 a.b,表示方式对应的输入字段到路径a.b。类型表示写入的数据类型。
三、结语
API数据源与离线集成任务涉及的业务场景复杂多变,本次的优化点旨在通过产品设计解决用户在API数据源集成场景下有关认证方式、路径配置等问题,以提高用户任务配置的便捷度与效率。