ASTRO轻应用 ASTROZERO-使用Rest服务调用Rest协议接口:创建并启用Rest Action

时间:2024-07-23 19:00:11

创建并启用Rest Action

通过创建Rest Action,使得系统可以调用第三方提供的Rest协议的接口,实现第三方提供的业务功能。

  1. 创建Rest Service(自定义连接器)中创建的Rest Service列表中,选择Rest Action所在的REST Service,在“动作”页签,单击“新建”。
  2. 参照表3,设置动作的基本信息,单击“下一步”。

    图4 新建动作设置基本信息

  3. 参照表4,设置消息头入参,单击“下一步”。

    如果此接口没有消息头输入参数,则不需要配置参数,请删除第一行参数。如果有消息头输入参数,且有多个,请单击。如果之前创建Rest Service时,有定义消息头参数,可选择“从模板中插入”,并定义输入参数的基本信息。消息头入参的参数说明请参见。
    图5 消息头入参配置页面

  4. 参照表5,设置输入参数,单击“下一步”

    如果此接口没有输入参数,则不需要配置参数,删除第一行参数。如果有输入参数,且有多个,请单击,并定义输入参数的基本信息。

    页面上方“消息体格式”参数使用说明:当方法为“PUT”或“POST”时,该参数才会显示。当第三方入参为数组类型或者非JSON类型时,需要将“输入消息体方式”设置为“值”形式。

    例如,如果设置“消息体格式”为“键-值”,假设定义了输入参数A、B、C,调用时消息体中传递了参数 {A: 1,B:2, C:3} ,此时被调用方收到的参数信息是 {A: 1,B:2, C:3}。如果设置“输入消息体方式”为“值”,此时默认使用$in输入参数定义,调用时消息体中传递了参数{$in: [1,2,3] },此时被调用方收到的参数信息为[1,2,3]。

    图6 输入参数配置页面

  5. 参照表6,设置输出参数,单击“保存”

    如果此接口没有输出参数,则不需要配置参数,请删除第一行参数。如果有输出参数,且有多个参数,请单击,并定义输出参数的基本信息。

    页面上方“消息体格式”参数使用说明:设置“输出消息体方式”为“值”后,系统会引入一个通用的出参变量“$out”,将body的内容存到“$out”中,作为出参。

    例如,若设置“消息体格式”为“键-值”,假设定义了输出参数A、B、C,调用后返回消息体中传递了参数 {A: 1,B:2, C:3} ,此时调用方收到的参数信息是 {A: 1,B:2, C:3};若设置“输出消息体方式”为“值”,此时默认使用$out输出参数定义,调用业务接口返回消息体中传递了参数[1,2,3],此时调用方收到的参数信息为{$out:[1,2,3]}。

    图7 输出参数配置页面

  6. 在动作页签,单击该Rest Action所在行的,启用Rest Action。

    单击“导出”,可导出zip包,zip包中包括该服务的所有Rest接口。单击“导入”,可通过导入yaml文件,导入Rest Action。

support.huaweicloud.com/usermanual-astrozero/astrozero_05_9201.html