创建数据后端
概述
ROMA Connect支持把数据源定义为后端服务,可以通过SQL的形式查询数据库中的数据,实现从数据源中读写数据,并以API的形式对外开放。
前提条件
数据源已创建,数据源存储的单行数据大小建议不超过2KB,若超过该限制会导致自定义后端响应异常。
操作步骤
- 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。
- 在左侧的导航栏选择“服务集成 APIC > 自定义后端”,在“后端列表”页签中单击“创建后端”。
- 在创建后端页面配置后端信息,完成后单击“立即创建”。后端创建完成后,页面自动跳转到该后端的编辑器页面,后端类型默认为数据后端。
图1 后端创建
- 配置数据后端。
- 在编辑器页面左侧单击“添加数据源”。
图2 添加数据源
- 在添加数据源弹窗中配置数据源信息,完成后单击“立即添加”,详细配置请参考表1。
图3 添加数据源
表1 数据源配置 参数
配置说明
选择数据源
选择配置数据源中已配置的数据源
选择执行语句类型
选择执行语句的类型,可选择“SQL”和“SP”(Stored Procedure)。如果是Redis或MongoDB数据源,选择“SQL”,实际执行语句为NoSQL。
高级设置
返回对象
填写返回对象的名称,执行语句的执行结果将封装在该对象中返回。
结果分页选项
执行语句的执行结果是否支持分页返回。若同一个数据后端添加多个数据源时,不支持配置“结果分页选项”。
若开启结果分页选项,可在后端请求中添加查询参数pageNum和pageSize,对查询结果进行分页,并指定返回第几页的数据。
- pageNum:分页时指定要返回第几页的数据,从1开始。
- pageSize:分页时每页包含的数据条数。开启和关闭结果分页选项时,响应结果的结构会有所不同,具体请参见《应用与数据集成平台(ROMA Connect) 1.10.0 使用指南(for 华为云Stack 8.2.1) 02》中结果分页示例说明。
说明:结果分页当前仅支持2000条以内数据的分页,若超过2000条数据,建议在执行语句中携带offset和limit参数进行分页。未开启“预编译”时,使用示例如下:select * from table01 limit ${limit} offset${offset}其中offset和limit参数key在后端服务请求的Headers、Parameters或Body中传递。若数据源开启了“预编译”,则还需要调用相应的函数对offset和limit参数进行数据类型转换,具体请参见《应用与数据集成平台(ROMA Connect) 1.10.0 开发指南(for 华为云Stack8.2.1)》的“服务集成开发指导 > 自定义后端开发(数据后端)”章节。
预编译
是否对执行语句进行预编译,可以防止SQL注入风险。
- 在编辑器页面左侧单击“添加数据源”。
- 添加数据源后,在编辑器左侧选择数据源,然后可以在右侧的语句编辑框中编写执行语句。
图4 选择数据源
- 测试后端功能。在页面右上角单击“测试”,在下方的“测试参数”处,根据后端的定义添加请求参数,然后单击“立即测试”,发送请求。
- 在“执行结果”处,可查看后端的响应结果。
- 在“执行历史”处,可查看后端的历史测试记录。单击测试记录,可以将历史测试参数导入到左侧测试参数中,并再次测试。
- 后端测试完成后,在页面右上角单击“部署”,在确认弹窗中单击“确定”,部署后端服务。
图5 部署后端