使用ROMA Connect集成服务

ROMA Connect支持将API、数据源和自定义函数封装成标准的RESTful API，并对外开放。ROMA Connect为API提供了完整的生命周期管理和多层的安全防护管理。

本章节通过完成一个使用ROMA Connect开放API的配置样例，帮助您快速熟悉使用ROMA Connect集成服务的过程。

使用ROMA Connect集成服务的步骤如下所示：

在开始操作前，您需要提前完成以下准备工作。

每个开放的API都要归属到某一个API分组下，在创建API前应提前创建API分组。

在创建分组弹窗中填写API分组相关配置信息，然后单击“确定”，创建API分组。

图1 创建API分组
点击放大

表1 API分组配置
参数	配置说明
分组名称	填写API分组的名称，根据规划自定义。建议您按照一定的命名规则填写API分组名称，方便您快速识别和查找。
可见范围	选择API分组的可见范围，此处选择“集成应用”。
集成应用	选择2中创建的集成应用。若没有可用的集成应用，可单击右侧的“新建集成应用”，创建一个集成应用。
描述	填写API分组的描述信息。

在ROMA Connect中创建一个用于对外开放的API，并与后端服务进行关联。

在创建API页面配置API的前端请求信息。

图2 前端请求信息

表2 前端请求信息
参数	配置说明
API名称	填写API的名称，根据规划自定义。建议您按照一定的命名规则填写API名称，方便您快速识别和查找。
集成应用	选择步骤一：创建API分组中创建的集成应用。若没有可用的集成应用，可单击右侧的“新建集成应用”，创建一个集成应用。
所属分组	选择步骤一：创建API分组中创建的API分组。
URL	配置API的URL。请求方法：选择API的请求方法，此处选择“GET”。请求协议：选择API使用的请求协议，此处选择使用“HTTPS”。路径：填写API的请求路径，格式如：/getUserInfo/{userId}，此处以“/test”为例。
匹配模式	选择API请求路径的匹配模式。为简单起见，此处选择“绝对匹配”。
标签	为简单起见，不设置标签。
描述	为简单起见，不填写描述信息。

配置API的安全配置信息。

图3 安全配置信息

表3 安全配置信息
参数	配置说明
类型	选择是否允许API上架到云市场，“公开”为表示允许。本配置样例中不涉及上架操作，此处保持默认设置即可。
安全认证	选择API使用的安全认证方式。为简单起见，此处选择使用“无认证”。
支持跨域CORS	选择API是否支持跨域访问。本配置样例中不涉及跨域访问，此处不开启。

配置API的后端配置信息。

图4 后端配置信息

表4 后端配置信息
参数	配置说明
Mock自定义返回码	选择API响应的HTTP状态码，此处选择“200”。
Mock返回结果	填写API的响应结果，此处填写为“ROMA TEST!”，即用户在调用该API时，API固定返回“ROMA TEST!”作为响应结果。
后端认证	选择是否使用自定义安全认证。为简单起见，此处不开启。
添加header参数	自定义API响应的header参数。为简单起见，此处不设置。

配置返回结果的响应示例，用于帮助API调用者了解API请求的响应信息。

图5 返回结果信息

表5 返回结果信息
参数	配置说明
成功响应示例	根据后端服务的成功响应消息来设置响应示例。此处成功响应示例设置为“ROMA TEST!”。
失败响应示例	调用API失败时系统返回的失败消息示例。为简单起见，此处不设置。