服务方法可以通过可视化的方式对服务进行逻辑编排。本文介绍如何创建和管理服务方法。
前提条件
当前应用为轻应用。
当前应用的版本状态处于开发中,尚未发布。
当前账号具有应用开发权限。
新建服务方法
在应用列表页面,单击目标轻应用名称。
在目标轻应用导航栏中,选择 。
在服务编排页面,单击新建服务方法。
您可以在服务编排的自定义页面创建自定义的服务方法,也可以在服务编排的系统方法页面查看平台预置的服务方法(编码以
_bw
结尾)。说明平台支持对自定义的服务方法进行子级分类管理。具体操作,请参见管理子分类。
在新建服务方法面板,完成下图所示的相关配置。
相关配置项说明,请参见下表。
配置项
说明
服务方法名称
自定义服务方法的名称。
编码
英文字母和数字的组合,以小写字母开头,且应用服务内唯一。
描述
服务方法描述,非必填。
开发模式
支持可视化编排和后端全代码,默认值为可视化编排。
需要登录
如果轻应用没有配置用户认证,则该选项为置灰状态。
如果轻应用已配置了用户认证,则该选项为默认选中。
关于用户认证的信息,请参见创建和管理用户认证)。
在开启用户认证后,用于设置调用该服务方法时是否需要用户为已登录状态,如果当前用户未登录,则对该服务方法的调用失败。
说明当用户认证处无生效的认证方式时,需要登录为置灰状态,且默认未选中。关于用户认证的信息,请参见创建和管理用户认证。
服务方法入参
单击添加入参,配置服务方法的入参。服务方法入参可以设置多个。更多信息,请参见服务方法入参。
服务方法出参
单击添加出参,配置服务方法的出参。出参最多仅可设置一个。更多信息,请参见服务方法出参。
表 1. 服务方法入参 参数
说明
参数名称
自定义服务方法入参名称。
编码
英文字母和数字的组合,以小写字母开头,且应用服务内唯一。
参数类型
通过参数类型下拉列表选择:
基本类型:String、Integer、Boolean等。
集合类型:List(支持基本类型、集合类型或结构对象)、Set(支持基本类型、集合类型或结构对象)、Map。
List和Set集合类型支持嵌套。
Map集合类型中Key和Value支持自定义,但不支持Map的嵌套。
对象类型:支持选择自定义或关联业务域目录下的结构对象。
说明如果要选择当前正在创建的结构对象,请在完成基本信息配置后单击保存,再通过单击目标结构对象右侧操作列下的编辑进行相应操作。
新建结构对象:您可以新建结构对象将其配置为字段的数据类型。
必填
默认不选中,为非必选项。如果选中必填,则该服务方法入参为必填参数。
描述
服务方法入参描述,非必填。
表 2. 服务方法出参 参数
说明
参数类型
通过参数类型下拉列表选择:
基本类型:String、Integer、Boolean等。
集合类型:List(支持基本类型、集合类型或结构对象)、Set(支持基本类型、集合类型或结构对象)、Map。
List和Set集合类型支持嵌套。
Map集合类型中Key和Value支持自定义,但不支持Map的嵌套。
对象类型:支持选择自定义或关联业务域目录下的结构对象。
说明如果要选择当前正在创建的结构对象,请在完成基本信息配置后单击保存,再通过单击目标结构对象右侧操作列下的编辑进行相应操作。
新建结构对象:您可以新建结构对象将其配置为字段的数据类型。
描述
服务方法出参描述,非必填。
单击创建。
服务方法保存成功后系统会自动打开服务方法编排设计器,您可以直接编排服务方法,具体操作,请参见可视化编排服务方法。您也可以在服务方法页面查看所创建的服务方法。
从数据源批量创建服务方法
在服务编排页面,单击从数据源批量创建。
在从数据源批量创建服务方法面板的左侧导航栏中,选中目标接口(单次最多选中10条数据),完成后单击保存。
说明您可以按需修改服务方法的名称和编码。
管理子分类
新建子分类
系统不支持创建顶级分类的同级分类,但您可以新建顶级分类的子分类。
在服务编排页面的左侧导航栏中,单击自定义右侧的图标后,单击新建子分类。
在新建子分类的对话框中,设置分类名称。
单击创建。
编辑子分类
在服务编排页面的左侧导航栏中,单击目标子分类右侧的图标后,单击编辑。
在编辑分类的对话框中,编辑分类名称。
单击保存。
删除子分类
在服务编排页面的左侧导航栏中,单击目标子分类右侧的图标后,单击删除。
说明您只能删除没有子分类的子分类。如果目标分类下有子分类,则不支持删除。
在二次确认对话框中,单击确认。
批量转移服务方法至目标分类
在服务编排页面的左侧导航栏中,单击目标分类后,在服务编排页面右侧,选中目标服务方法(支持多选)。
单击转移分类。
在批量转移分类对话框中,在服务方法分类下拉列表中,选择目标分类。
单击转移。
页面提示转移成功,您可以在目标分类的服务方法列表中找到被转移的服务方法。
批量删除服务方法
在服务编排页面的左侧导航栏中,单击目标分类后,在服务编排页面右侧,选中目标服务方法(支持多选)。
单击删除。
在二次确认对话框中,单击删除。
编辑服务方法
在服务方法页面,单击目标服务方法名称或目标服务方法右侧操作列下的编辑属性。
在编辑服务方法面板,完成配置信息修改后,单击保存。
复制服务方法
在服务方法页面,单击目标服务方法右侧操作列下的 。
在复制服务方法面板,按需完成相关配置项信息修改。
单击保存并打开设计器。
界面会自动跳转至编排该服务方法的画布,您可以进行编排服务方法操作。具体操作,请参见可视化编排服务方法。
删除服务方法
在服务方法页面,单击目标服务方法右侧操作列下的 。
在二次确认对话框中,单击删除。