检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
功能 说明 API可视化设计 ROMA API集成了标准的Swagger编辑器,支持编辑器编辑和表单编辑两种方式,并提供规范性检查功能,使用户可以快速、高效的在线进行API Swagger文档的设计。 API快速实现 ROMA API支持通过导入API文档一键生成代码仓以及流水线,降低开发时间。
支持编辑或修改应用名称和描述。 在搜索框中输入需要编辑的应用名称。 单击对应应用所在行的“编辑”,即可编辑应用信息。 删除应用 已创建的应用不再提供服务,可以将应用删除。 在搜索框中输入需要删除的应用名称。 单击对应应用所在行的“删除”,即可删除应用信息。 更新应用 刷新全局应用信息。 在页面右上角单击刷新应用列表。
API控制台。 在控制台单击,选择区域。 在左侧导航栏单击“总览”。 “总览”页面展示分别展示ROMA API概念,提供的能力,以及操作指引。 您可以根据不同角色查看行为路径,或者单击“查看指引”查看详细的操作指引。 初级使用者入门指导 中级使用者入门指导 高级使用者,敬请期待。 API治理专家,敬请期待。
有可用的VPC,并且已配置好子网与安全组,否则请参考准备资源完成VPC、子网和安全组的创建。 ROMA Connect实例的可用配额不为0。如果可用配额为0,可以删除无用实例或者申请扩大实例配额。 APIG实例: 购买APIG实例的前提条件请参考购买专享版实例中的“购买专享版的约束说明”和“网络环境准备”。
情”,审批订阅信息。 仅支持拥有租户管理员权限者审批。 图5 审批申请 订阅成功后,B部门可以调用A部门的API。 订阅成功后,可以在“订阅与凭证”中查看该凭证下已经订阅成功的产品,也可以取消订阅产品。 图6 订阅成功 (可选)返回目录列表,单击产品名称,选择版本号进入,可查看已开放的API以及进行调试。
凭据配额用于限制凭据在某个时间周期内的API调用次数,支持自定义重置时间。 绑定访问控制策略 客户端访问控制可控制访问API的客户端IP地址,保护后端服务。您可以为客户端设置访问控制策略,允许/禁止某个IP地址的客户端访问API。 绑定API 在当前凭据下绑定API,绑定后的API拥有当前凭据下的所有策略。
选择策略的类型,不同类型的策略提供不同扩展能力。 跨域资源共享:为API的跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的能力。 HTTP响应头管理策略:可以自定义HTTP响应头,在返回的API响应中指定配置的响应头。 可见范围 当实例为ROMA类型时,支持设置当前应用可见或全局应用可见。 描述
如果产品已上架,那么需要提交修改申请。 填写申请描述后,单击“确定”。 审核申请通过后,产品信息编辑成功。 删除 API产品不再提供服务,且产品已下架,可以将API产品删除。 在API产品所在行,单击“删除”。 确认删除产品信息后,单击“确定”。 不推荐 不推荐表示产品待下架。待下架的产品不推
使用app_secret认证时,需同时关闭app_api_key认证方式。 app_route 支持IP访问开关。启用后,非DEFAULT服务下的API可以使用IP地址调用。 backend_client_certificate 后端双向认证开关。启用后,创建API配置后端服务时,可配置后端双向认证。
部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 HTTP响应头管理策略 3 SLA配置 提前设计接口运行的可靠性和性能指标。 配置SLA 4 导入规则检查 系统根据默认API导入规则,检测API文件。 导入到API服务 5 后端开发 用户可以快速生成代码,并完成后端的服务能力开发。
ID)/SK(Secret Access Key)认证调用请求。其签名方式和APP认证相似。 使用自定义认证调用API 如果您希望使用自己的认证方式,可以在函数服务中编写一个函数,将其作为您的认证服务。 使用无认证调用API 对API请求不进行认证。 通过多种开发语言对后端服务进行签名 指导
API测试 通过导入API生成测试用例,快速实现API测试覆盖。 使用场景 API上线后,测试API连通性,以及通过定时测试任务来保障API稳定且长效运行。 前提条件 对应实例已绑定弹性IP地址。 已开通测试计划。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
分析日志 快速获取并分析API的调用日志。 前提条件 已调用API。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。 单击“日志分析”。
产品优势 全自动化设计规范检测 从设计者体验和效率出发,提供一款便捷的API编辑器,支持标准Swagger的编辑能力和通俗易懂的表单编辑能力,并融入华为10年累积的API治理规范标准,实现全自动化检测,提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约,自动
创建SSL证书 如果API服务中的API支持HTTPS请求协议,则在绑定独立域名后,还需为独立域名添加SSL证书。 前提条件 仅支持添加pem编码格式的SSL证书。 添加的SSL证书仅支持RSA、ECDSA和DSA加密算法。 创建SSL证书 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
本文介绍了ROMA API提供的开放API的SDK语言版本,列举了最新版本SDK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表,您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址
息以及通过该凭证订阅的产品信息。 单击“创建凭证”,填写凭证基本信息。 图1 填写基本信息 单击“确定”,创建完成。 凭证创建完成后,您还可以执行如下列操作。 去订阅 通过已创建凭证订阅API产品。 重置Secret 在“凭证信息”区域,凭证“Key”和“Secret”是创建凭证
审核管理 为产品上架/不推荐/下架/订阅过程提供审核机制,API管理者发起上架/不推荐/下架/订阅请求时,IAM用户(其他管理者)都可以参与到评审中,让更多用户参与到API产品审视中,以确保产品的正确性。 审核流程: 提交申请 查看申请 审核申请 提交申请 登录ROMA API控制台。
已使用凭证订阅了API所在产品的凭证。 填写API的Headers参数。 填写API的Params参数。 已定义Body 通过切换输入方式可以选择表单填写或文本输入请求体。 未定义Body 通过POST/PUT/PATCH方法请求的API支持展示自定义填写。 说明: 如果API已