发布数据API

更新时间：2024-05-07 GMT+08:00

查看PDF

在数据后端创建后，您需要发布数据后端，生成数据API并发布到环境上，才可供其他用户调用。

前提条件

每个API都要归属到某个API分组下，在发布函数API前您需要有可用的API分组，否则请提前创建API分组。
如果需要使用自定义认证方式进行API的安全认证，请提前创建前端自定义认证。

限制与约束

如果为自定义后端发布的前端API的请求路径增加了请求参数，那么无法在自定义后端的发布页面进行发布，需要在前端API页面进行发布操作。如果只修改了自定义后端的内容，建议重新部署即可，无需重新发布。

操作步骤

登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。
在左侧的导航栏选择“服务集成 APIC > 自定义后端”。
在后端列表中单击自定义后端的名称，进入后端编辑器页面。
在页面右上角单击“发布”。

在发布弹窗中配置数据API的相关信息，完成后单击“立即发布”，为该后端创建一个对应的前端数据API，并发布到环境上。

表1 发布配置
参数	说明
所属分组	选择前端API所属的API分组。若没有可用的API分组，可单击右侧的“创建分组”，创建一个API分组。说明：创建API后，将无法修改API所属的API分组，API分组关系到API的访问域名，请谨慎选择。
发布环境	选择前端API要发布的环境。如果没有您需要的环境，可单击右侧的“创建环境”，创建一个环境。
前端安全认证	选择前端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时，表示不开启重试功能，但除POST和PATCH外的其他请求类型会默认重试1次。值为0-10时，表示开启重试功能，并根据设置的值执行重试。
高级设置
前端请求方法	选择前端API的请求方法。“ANY”表示该API支持任意请求方法。
前端请求路径	填写前端API的请求路径，格式如：/getUserInfo/userId。请求路径中的内容区分大小写。
支持跨域(CORS)	是否支持跨域访问API。浏览器出于安全性考虑，限制从页面脚本内发起的跨域请求，此时页面只能访问同源的资源。而CORS允许浏览器向跨域服务器发送XMLHttpRequest请求，从而实现跨域访问。跨域访问API请参见配置跨域访问API。

父主题： 开放数据API

上一篇：创建数据后端

下一篇：绑定域名

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消