更新时间:2022-04-26 GMT+08:00
分享

创建并启用Rest Action

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

前提条件

已获取第三方提供的Rest服务的URL地址、输入参数、输出参数、内容类型信息。

场景描述

若需要调用第三方提供的Rest协议的flapRefund接口,则需要该Rest Service。

操作步骤

  1. 在App开发界面左侧列表单击,选择“自定义连接器 > 自定义连接器”。
  2. 在Rest Service列表中选择Rest Action所在的REST Service,选择“动作”页签,单击“新建”。
  3. 在弹出的页面配置Action基本信息,单击“下一步”。

    图1 新建动作配置页面
    表1 新建Rest Action参数说明

    参数名

    说明

    标签

    新建Rest Action的标签名,长度不超过64个字节。

    名称

    新建Rest Action的名称,唯一标识,长度不超过255个字节。

    URL

    第三方提供Rest协议服务的URL地址。

    方法

    直接在下拉框中选择Rest方法。

    • GET:获取资源。
    • POST:创建资源。
    • PUT:更新资源。
    • PATCH:用于资源的部分内容的更新。
    • DELETE:删除资源。
    • OPTIONS:用于获取当前URL所支持的方法。

    方法选择“PUT”或“POST”时,可自定义输入消息体参数。当第三方入参为数组或非JSON类型时,需要在定义输入参数时设置为“键-值”形式。勾选后系统会引入一个通用的入参变量“$in”,将数组或非JSON类型的变量存到“$in”中,变成“键-值”格式传入到Rest Action中。

    内容类型

    请手工输入内容类型,该值取决于第三方支持哪种类型,是在HTTP标准协议中定义的。

    返回类型

    取值为“application/json”时,表示会忽略第三方实际返回的“content-type”,使用第三方配置的“content-type”来解析第三方返回的内容。

    如果该参数取值为空,表示使用http返回中的“content-type”来解析第三方返回的内容。

    超时时间

    当超出该参数设定的时间,第三方没有返回结果时,系统报错。

    日期格式

    若该Rest服务输入参数包括Date类型且有固定的要求格式,则必须进行配置。

    请确保AppCube提供的输入参数符合第三方要求。例如,该Rest服务存在Date类型输入参数,且要求格式为“YYYY-MM-DD”,则此处必须配置为“YYYY-MM-DD”。

    日期/时间格式

    若该Rest服务输入参数包括DateTime类型且有固定的要求格式,则必须进行配置。

    请确保AppCube提供的输入参数符合第三方要求。例如,该Rest服务存在DateTime类型输入参数,且要求格式为“YYYY-MM-DD hh:mm:ss”,则此处必须配置为“YYYY-MM-DD hh:mm:ss”。

    描述

    描述信息,长度不能超过255个字节。

  4. 消息头入参设置。

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

    参数

    说明

    标签

    消息头输入参数的标签名,长度不超过64个字节。

    名称

    消息头输入参数的名称,唯一标识,长度不超过255个字节。

    数据类型

    消息头输入参数的数据类型。

    • 数字:数字类型。
    • 字符串:字符串类型。
    • 布尔值:布尔类型,取值为“true”和“false”。

    默认值

    参数的默认取值。

    描述

    消息头输入参数的描述信息,长度不超过255个字节。

    默认

    参数是否有默认值。

    必填

    参数是否必填。

    操作

    单击,可对Header输入参数进行添加或删除操作。

  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]。

    图3 输入参数配置页面
    表3 输入参数说明

    参数

    说明

    标签

    输入参数的标签名,长度不超过64个字节。

    名称

    输入参数的名称,唯一标识,长度不超过255个字节。

    参数位置

    输入参数位置。

    • 消息体
    • URL查询参数
    • URL路径参数

    数据类型

    输入参数的数据类型。

    • 日期:日期类型,精度到天。
    • 日期/时间:时间类型,精度到秒。
    • 数字:数字类型。
    • 字符串:字符串类型。
    • 布尔值:布尔类型,取值为“true”和“false”。
    • 全局结构体:全局结构体类型,由命名空间和结构体类型共同决定。
    • 键值对(Map):Map集合类型。
    • 对象:对象标识类型。

    命名空间

    输入参数所属的命名空间。

    结构体类型

    输入参数结构体类型。

    对象

    当“结构体类型”为对象时,需要设置具体的对象。

    默认值

    参数默认取值。

    描述

    输入参数的描述信息,长度不超过255个字节。

    默认

    参数是否有默认值。

    必填

    输入参数是否必填。

    勾选,表示是必填字段。

    集合

    输入参数是否是数组型。

    勾选,表示是数组型。

    操作

    单击,可添加或删除输入参数。

  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]}。

    图4 输出参数配置页面
    表4 输出参数配置页面参数说明

    参数

    说明

    标签

    输出参数的标签名,长度不超过64个字节。

    名称

    输出参数的名称,唯一标识,长度不超过255个字节。

    参数位置

    参数位置。

    数据类型

    输出参数的数据类型。

    命名空间

    输出参数所属的命名空间。

    结构体类型

    结构体类型。

    对象

    当“结构体类型”为对象时,需要设置具体的对象。

    描述

    关于输出参数的描述信息。

    长度不超过255个字节。

    集合

    输出参数是否是数组型。

    勾选,表示是数组型。

    操作

    单击,可添加或删除输出参数。

  7. 单击“保存”。
  8. 进入“REST操作”列表页面,单击该Rest Action所在行的,进行启用。

    单击“导出”可导出zip包,zip包中包括该服务的所有Rest接口。

    在“动作”页签单击“导入”,通过导入yaml文件可导入Rest Action。

服务编排中调用Rest Action

您可以在业务Flow中调用刚创建的Rest Action。

  1. 在Flow编辑器页面左侧选择“连接器 > 自定义 > 服务名”,拖拽具体的Rest服务图标至画布中,弹出配置窗口。
  2. 设置调用Rest Action参数。

    图5 配置“Rest Action”
    表5 参数说明

    参数

    说明

    认证信息

    选择3配置的认证信息。不同的Rest Action可以有不同的认证方式。

    动作

    调用的Rest Action。

    输入参数

    输入参数。

    单击“新增行”可进行添加。

    输出参数

    输出参数。

脚本中调用

您可以在脚本中调用刚创建的Rest Action,这里以新建一个脚本为例进行举例说明。

  1. 鼠标放在App下的Logic文件夹旁会出现加号,单击加号,选择“脚本”。
  2. 选择“创建一个新脚本”,输入基本信息,单击“添加”。
  3. 编辑代码如下,其中“LT927__test”表示连接器名称,“test1”为3配置的认证信息名称,“LT927__flapRefund”为3配置的动作名称。

    // Here's your code.
    import * as connector from "connector";
    let client = connector.newClient("LT927__test", "test1");
    let result = client.invoke("LT927__flapRefund", {});
    console.log(result) 

  4. 单击代码编辑页面上方保存图标,保存脚本。
  5. 运行测试脚本。

    1. 单击编辑器上方执行图标。
    2. 在页面底部“输入参数”页签输入请求参数,单击测试窗口右上角图标。检查脚本编辑页面下方“日志”页签打印的日志。

分享:

    相关文档

    相关产品

关闭导读