概述
通过创建数据API,把停车场管理系统中的车位状态数据开放给第三方应用,供车主、
城市管理者了解停车场车位情况。
操作步骤
1. 创建后端。
a. 在左侧的导航栏选择“服务集成 APIC > 自定义后端”,在“后端列表”页签 中单击“创建后端”。
b. 在创建后端页面填写后端相关配置信息,完成后单击“立即创建”。
表1-14 后端配置
参数 配置说明
后端名称 填写后端的名称,自定义。
集成应用 选择在ROMA Connect注册设备中创建的集成应用。
后端请求方法 选择后端的请求方法,此处选择“GET”。
后端请求路径 填写后端的请求路径,格式如:/serviceName/
interfaceName。
后端安全认证 选择后端的安全认证方式。本实践中开放的API与后端 服务在同一实例内,此处选择“无认证”。
描述 填写后端的描述信息。
参数 配置说明
选择数据源 选择创建MQS到数据库的集成任务中接入的MySQL数据 源。
假设MySQL数据库中存储车位信息和车位状态信息的数据表名为
“ParkingData”,表中车位状态字段为“Status”。
SELECT COUNT(Status) AS FreeNo FROM ParkingData WHERE Status="0";
d. 完成后在页面右上角单击“保存”,保存数据后端配置。
e. 在页面右上角单击“测试”,然后在下方的测试窗口中单击“立即测试”。
在“执行结果”栏查看后端的响应结果是否为如下JSON数据,其中xxx为统 计返回的空余车位数量值。
{"default":[{"FreeNo":xxx}]}
f. 后端测试完成后,在页面右上角单击“部署”,然后在弹窗中单击“立即部 署”,部署数据后端。
3. 发布数据API。
a. 后端部署完成后,在页面右上角单击“发布”。
b. 在发布弹窗中填写发布相关参数,完成后单击“立即发布”,为该后端创建 一个对应的前端数据API,并发布到环境上。
表1-16 发布后端
参数 配置说明
所属分组 选择前端API所属的API分组。若没有可用的API分组,
可单击右侧的“创建分组”,创建一个API分组。
发布环境 选择默认的“RELEASE”环境
前端安全认证 选择前端API的安全认证方式,推荐使用APP认证方式。
● APP认证:表示由ROMA Connect对API请求进行安 全认证。用户调用API时,使用集成应用的Key和 Secret进行API请求的安全认证。
● 华为IAM认证:表示由IAM对API请求进行安全认 证。用户调用API时,使用Token或AK/SK进行API请 求的安全认证。
● 自定义认证:表示使用自定义的函数API对API请求 进行安全认证。
● 无认证:表示API请求不需要认证。
自定义认证 仅当“前端安全认证”选择“自定义认证”时需要配 置。
选择已创建的前端类型自定义认证。
前端请求协议 选择前端API使用的请求协议,可选择“HTTP”、
“HTTPS”和“HTTP&HTTPS”,传输重要或敏感数据 时推荐使用HTTPS。
后端超时 (ms) 后端服务请求的超时时间,默认为60000ms。
重试次数 ROMA Connect调用后端服务失败后的重试次数。
● 值为-1时,表示不开启重试功能。
● 值为0-10时,表示开启重试功能,并根据设置的值 执行重试。
高级设置
前端请求方法 选择前端API的请求方法。“ANY”表示该API支持任意 请求方法。
前端请求路径 填写前端API的请求路径,格式如:/getUserInfo/
userId。
请求路径中的内容区分大小写。
支持跨域(CORS) 是否支持跨域访问API,此处选择不启用。
4. 为数据API绑定独立域名。
a. 在左侧的导航栏选择“服务集成 APIC > API管理”,在“API分组”页签中单 击数据API所属API分组右侧的“更多 > 域名管理”。
b. 在域名管理页签下单击“绑定独立域名”。
c. 在绑定独立域名弹窗中填写要域名配置信息,完成后单击“确定”。
表1-17 独立域名配置
参数 配置说明
域名 填写要绑定的域名。
支持最小TLS版
本 选择域名访问所使用的最小TLS版本。
d. (可选)如果数据API支持HTTPS请求协议,则需要为独立域名添加SSL证 书。否则跳过此步骤。
i. 在已绑定的独立域名右侧单击“添加SSL证书”。
ii. 在添加SSL证书弹窗中配置证书相关信息,完成后单击“确定”,完成 SSL证书的添加。
表1-18 SSL 证书配置
参数 配置说明
证书名称 填写证书的名称,自定义。
证书内容 填写pem编码格式的SSL证书内容。
密钥 填写pem编码格式的SSL证书密钥。
5. 在左侧的导航栏选择“服务集成 APIC > API管理”,在“API列表”页签中单击数 据API的名称,进入API详情页面。
在“调用信息”页签的“请求基础定义”下,可获取数据API的“子域名”、“请 求协议”、“请求方法”和“请求路径”,并提供给第三方应用使用。