使用自定义连接器调用第三方接口
在使用AstroZero时,通常会调用第三方系统接口,进行数据交互。
场景描述
通过使用AstroZero的自定义连接器、服务编排或脚本功能,带您快速对接一个外部服务的接口并暴露为自己的接口。在此案例中,假设您需要对接一个已有的Rest服务,通过Rest服务获取数据并加工,最终暴露为自己的服务接口。
以表1中的Rest服务接口为例,介绍如何在AstroZero中配置对应的自定义连接器。
前提条件
步骤1:创建自定义连接器
- 参考如何登录新版应用设计器中操作,登录新版应用设计器。
- 在左侧导航栏中,选择“集成”。
- 单击“连接器”中的“ 连接器实例”,进入连接器实例页面。
- 在类型中,选择“自定义连接器”,进入自定义连接器页面。
- 单击“+”,配置连接器信息,单击“保存”。
图2 创建自定义连接器
- 标签:REST服务的标签名。
- 名称:REST服务的名称,系统会自动在该名称前添加命名空间__。
- 图标:REST服务的图标。
- 描述:REST服务的相关描述信息。
- 在“动作”页签中,新建自定义连接器动作,设置动作的基本信息,单击“下一步”。
图3 新建动作-设置基本信息
- (可选)设置消息头入参,单击“下一步”。
若此接口没有消息头输入参数,则不需要配置参数,请单击删除第一行参数。若有消息头输入参数,且有多个,请单击“新增”。
图4 消息头入参配置页面
- 设置输入参数,单击“下一步”。
该步骤配置的是请求的路径或消息体对应的内容,由参数的“参数位置”决定是路径参数还是消息体参数。
此案例中,我们要配置一个URL查询参数为key,请求体参数request的入参。
图5 输入参数配置页面
- 设置输出参数,单击“保存”。
配置输出的参数,取决于“参数位置”,该参数可能来自于响应消息头或者请求消息头。此案例中,我们了解到响应体有一个response的参数。
图6 输出参数配置页面
- 在动作页签,单击该动作所在行的,启用该动作。
步骤2:配置连接器认证信息
自定义连接器在服务编排或脚本中调用时,需要先配置认证信息。
- 参考步骤1:创建自定义连接器中操作,进入自定义连接器页面。
- 在“认证信息”页签,单击“新建”,进入添加认证信息页面。
- 设置认证信息,单击“保存”。
AstroZero提供了丰富的认证类型供用户选择,请按照自身业务需求,配置对应的认证信息。图7 配置连接器认证信息页面
步骤3:在服务编排中调用自定义连接器
以服务编排为例,调用已创建的连接器。
- 参考如何登录新版应用设计器中操作,登录新版应用设计器。
- 在左侧导航栏中,选择“逻辑”。
- 单击编排后,设置服务编排的标签和名称,单击“添加”。
图8 添加一个服务编排
- 在服务编排设计器页面左侧,“连接器 > 自定义 > 服务名”,拖拽步骤1:创建自定义连接器中的Rest服务图标至画布中。
请确保自定义连接器中已添加认证信息(如步骤2:配置连接器认证信息),否则此处无法拖动。
- 配置要调用的动作。
图9 配置要调用的动作
- 单击服务编排设计器页面上方的,保存服务编排。
- 保存成功后,单击,运行服务编排。
如果Rest服务无法调通,可以通过工具栏上的“跟踪”按钮查看运行日志,例如最常见的网关不可达:
图10 网关不可达
步骤四:把服务编排应用到业务逻辑中
调通服务编排后,可以把服务编排用于您的业务逻辑中,详情请参考使用服务编排相关案例。