使用ROMA Connect集成服务
概述
ROMA Connect支持将API、数据源和自定义函数封装成标准的RESTful API，并对外开放。ROMA Connect为API提供了完整的生命周期管理和多层的安全防护管理。
本章节通过完成一个使用ROMA Connect开放API的配置样例，帮助您快速熟悉使用ROMA Connect集成服务的过程。
使用ROMA Connect集成服务的步骤如下所示：
步骤一：准备后端服务
在使用ROMA Connect开放API前，您需要准备一个可调用的API，作为本配置样例中的后端服务。为简单起见，我们自定义一个无需请求认证、不带请求参数的函数API作为后端服务。
- 创建集成应用。
- 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。
- 在左侧的导航栏选择“集成应用”，单击页面右上角的“创建集成应用”。
- 在创建集成应用弹窗中填写集成应用的“名称”，然后单击“确认”。
- 创建函数API。
- 在左侧的导航栏选择“服务集成 APIC > 自定义后端”，在“后端列表”页签中单击“创建后端”。
- 在创建后端页面填写后端相关配置信息，完成后单击“立即创建”。图1 创建后端
表1 后端配置 参数
配置说明
后端名称
填写后端的名称，根据规划自定义。建议您按照一定的命名规则填写后端名称，方便您快速识别和查找。
集成应用
选择1中创建的集成应用。
后端请求方法
选择后端的请求方法，此处选择“GET”。
后端请求路径
填写后端的请求路径，格式如：/serviceName/interfaceName。
后端安全认证
选择后端的安全认证方式。为简单起见，此处选择“无认证”，即调用该后端时无需认证鉴权。
描述
填写后端的描述信息。
高级设置
为简单起见，不配置高级设置。
后端创建完成后，页面自动跳转到该后端的编辑器页面。
- 为简单起见，我们使用ROMA Connect提供的参考脚本来实现一个简单函数后端。
在编辑器的左上角单击“文件 > 新建函数后端 > Hello world示例”，在弹窗中单击“确定”，脚本编辑框中显示系统内置的Hello world脚本。
- 把脚本中的返回内容“Hello world!”改为“ROMA TEST!”，即调用该后端时，将返回响应消息“ROMA TEST!”。完成后在页面右上角单击“保存”。
function execute(data){ return "ROMA TEST!" } - 在页面右上角单击“测试”，然后在下方的测试栏中单击“立即测试”。
在“执行结果”栏查看后端的响应结果是否为2.d中定义的响应消息“ROMA TEST!”。
- 后端测试完成后，在页面右上角单击“部署”，然后在弹窗中单击“立即部署”，部署函数后端。
- 后端部署完成后，在页面右上角单击“发布”。
- 在发布弹窗中填写发布相关参数，完成后单击“立即发布”，为该后端创建一个对应的前端函数API，并发布到环境上。
表2 发布后端 参数
配置说明
所属分组
选择前端API所属的API分组。
为简单起见，如果有默认API分组，则直接选择默认API分组。如果没有，单击“创建分组”，在创建分组弹窗中直接单击“确定”，创建一个API分组并使用。
发布环境
选择默认的“RELEASE”环境
前端安全认证
选择前端API所使用的安全认证方式。为简单起见，选择“无认证”。
前端请求协议
选择前端API所使用的请求协议。保持默认选择“HTTPS”。
后端超时
前端API调用后端服务的超时时间。使用系统默认值“60000”。
重试次数
ROMA Connect调用后端服务失败后的重试次数。使用系统默认值“-1”。
- 值为-1时，表示不开启重试功能。
- 值为0-10时，表示开启重试功能，并根据设置的值执行重试。
高级设置
为简单起见，不配置高级设置。
- 函数API发布完成后，页面自动跳转到对应函数API的API详情页面，在“调用信息”页签的“请求基础定义”下，获取函数API的“子域名”、“请求协议”、“请求方法”和“请求路径”，并记录下来。
步骤二：创建API分组
每个开放的API都要归属到某一个API分组下，在创建API前应提前创建API分组。
- 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。
- 在左侧的导航栏选择“服务集成 APIC > API管理”，然后在“API分组”页签中单击“创建分组”。
- 在创建分组弹窗中填写API分组相关配置信息，然后单击“确定”，创建API分组。图2 创建API分组
表3 API分组配置 参数
配置说明
分组名称
填写API分组的名称，根据规划自定义。建议您按照一定的命名规则填写API分组名称，方便您快速识别和查找。
类型
选择API分组的类型，此处选择“集成应用”。
集成应用
选择步骤一：准备后端服务中创建的集成应用。若没有可用的集成应用，可单击右侧的“新建集成应用”，创建一个集成应用。
描述
填写API分组的描述信息。
步骤三：创建API
在ROMA Connect中创建一个用于对外开放的API，并与后端服务进行关联。
- 在“API列表”页签中，单击“新建API”。
- 在新建API页面中，根据页面向导配置API相关信息。
- 配置API的基本信息，完成后单击“下一步”。图3 API基本信息
表4 API基本信息 参数
配置说明
API名称
填写API的名称，根据规划自定义。建议您按照一定的命名规则填写API名称，方便您快速识别和查找。
集成应用
选择步骤一：准备后端服务中创建的集成应用。若没有可用的集成应用，可单击右侧的“新建集成应用”，创建一个集成应用。
所属分组
选择步骤二：创建API分组中创建的API分组。
类型
选择是否允许API上架到云市场，“公开”为表示允许。本配置样例中不涉及上架操作，此处保持默认设置即可。
安全认证
选择API使用的安全认证方式。为简单起见，此处选择使用“无认证”。
须知：Site实例中创建API不支持华为IAM认证。
标签
为简单起见，不设置标签。
描述
为简单起见，不填写描述信息。
- 定义API的请求信息，此请求信息将开放给外部用户使用。完成后单击“下一步”。图4 API请求配置
表5 API请求配置 参数
配置说明
请求协议
选择访问API所使用的请求协议，此处选择使用“HTTPS”。
请求Path
填写API的请求路径，格式如：/serviceName/interfaceName。
匹配模式
选择请求路径的匹配模式。为简单起见，此处选择“绝对匹配”。
Method
选择API的请求方法，此处选择“GET”。
支持跨域(CORS)
选择API是否支持跨域访问。本配置样例中不涉及跨域访问，此处不开启。
入参定义
定义接口的请求参数。为简单起见，此处不定义请求参数。
- 配置API的后端服务信息，即作为后端服务的API访问信息。
若您是参考步骤一：准备后端服务来准备的函数API，则此处配置该函数API的访问信息。
完成后单击“下一步”。图5 API后端服务配置
表6 API后端服务配置 参数
配置说明
后端服务类型
本配置样例中使用API作为后端服务，此处选择“HTTP/HTTPS”。
协议
选择步骤一：准备后端服务中记录的函数API“请求协议”。
请求方式
选择步骤一：准备后端服务中记录的函数API“请求方法”。
使用负载通道
本配置样例中不涉及负载通道的使用，选择“不使用”。
后端服务地址
填写后端服务的访问地址，格式为“主机:端口”。主机为后端服务的访问IP或域名，未指定端口时，HTTP协议默认使用80端口，HTTPS协议默认使用443端口。
填写步骤一：准备后端服务中记录的函数API“子域名”。
后端请求Path
填写后端服务的请求路径，格式如：/serviceName/interfaceName。填写步骤一：准备后端服务中记录的函数API“请求路径”。
后端超时(ms)
ROMA Connect调用后端服务的超时时间。使用系统默认值“5000”即可。
重试次数
ROMA Connect调用后端服务失败后的重试次数。使用系统默认值“-1”。
- 值为-1时，表示不开启重试功能。
- 值为0-10时，表示开启重试功能，并根据设置的值执行重试。
双向认证
选择是否在ROMA Connect和后端服务间启用双向认证。为简单起见，此处不开启。
后端认证
后端服务是否对ROMA Connect发送的调用请求进行认证。为简单起见，此处不开启。
后端服务参数
本配置样例中后端服务不带请求参数，无需设置。
常量参数
本配置样例中后端服务不带请求参数，无需设置。
系统参数
本配置样例中后端服务不带请求参数，无需设置。
- 配置API的返回结果示例，该示例用于在API的调用信息中展示。完成后单击“完成”。图6 API响应示例配置
表7 API响应示例配置 参数
配置说明
成功响应示例
根据后端服务的成功响应消息来设置响应示例。此处成功响应示例设置为“ROMA TEST!”。
失败响应示例
调用API失败时系统返回的失败消息示例。为简单起见，此处不设置。
- 配置API的基本信息，完成后单击“下一步”。
- API创建成功后，单击“返回API列表”，然后在API列表中可以查看刚创建的API。
步骤四：调试API
在完成API创建后，可以先对API进行调试，确保API的功能正常。
- 在“API列表”页签中，单击API后的“更多 > 调试”。
- 因为该API未定义请求参数，在调试API页面中直接单击“发送请求”，进行API调用测试。
- 在页面右侧可查看调用API发送的请求消息及响应消息。
