检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
生成产品 ROMA API支持把API服务中的API资源作为一个产品,共享给其他用户使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。
配置网关响应 网关响应指ROMA API未能成功处理API请求,从而产生的错误响应。ROMA API提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API服务管理中新增网关响应,其中响应内容符合JSON格式即可。 例如,“default”网关的响应内容为:
配置环境和环境变量 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境
产品优势 全自动化设计规范检测 从设计者体验和效率出发,提供一款便捷的API编辑器,支持标准Swagger的编辑能力和通俗易懂的表单编辑能力,并融入华为10年累积的API治理规范标准,实现全自动化检测,提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约,自动
curl 操作场景 使用curl命令调用APP认证的API时,您需要先下载JavaScript SDK生成curl命令,然后将curl命令复制到命令行调用API。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 调用API示例
应用场景 企业API文档规范统一 当今企业随着系统内部功能逐渐增多,子系统数量成倍增长,各个系统间调用依赖愈发重要,此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器,通过规范化、标准化的API文档形成稳定资产,快速完成内部系统对外接口的统一,有效降低开发成本。
签名密钥 签名密钥用于后端服务验证API的身份,在API请求后端服务时,保障后端服务的安全。 签名密钥是由一对Key和Secret组成,当签名密钥创建后,ROMA API向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果与
调试API API创建后需要验证服务是否正常,控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
管理API设计 您可以在创建的API设计文件内,创建多个API,对API进行Tag分类,或者以YAML或JSON格式导出到本地,用于导入API设计或其他用途。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏单击“API设计”。
发布API 在API创建后,您需要把API发布到环境,API只有在发布到环境后,才支持被其他用户调用。 作为初级使用者,成功创建API后,您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者,在创建API服务时,您可以把服务部署到环境上,同时间接地发布API。
管理API API创建完成后,在API列表中显示新建API,同时也支持编辑、授权、下线等操作管理API。 管理API 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。
什么是ROMA API ROMA API是为API提供全生命周期治理的服务,解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑,解决企业发展过程中各阶段遇到的问题,帮助企业快速实现API经济,持续构建高质量的API服务能力。
企业内部开放API及文档 本章节讲述企业内部如何开放API及文档。企业内部之间通过ROMA API将服务或数据变现,内部之间相互调用实现资源共享。 例如,部门A在ROMA API开放API,设计API、生成产品并上架到API目录,部门B通过API目录查看和订阅API。此时,部门A
创建API设计 ROMA API提供了可视化的API在线设计能力,及接口规范性检查,帮助用户快速设计标准的RESTful API。在开始设计API前,您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。 本地已存在API设计
API测试 通过导入API生成测试用例,快速实现API测试覆盖。 使用场景 API上线后,测试API连通性,以及通过定时测试任务来保障API稳定且长效运行。 前提条件 对应实例已绑定弹性IP地址。 已开通测试计划。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
创建API产品 API产品是从服务中挑选想要共享的API组合而成,即为将要上架的API的集合。 新建API产品 创建新的API产品。 添加API到产品 为已创建的API产品添加API。 新建API产品 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。
API指标分析 云监控对ROMA API的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
API管理 API服务管理 APIs管理 API列表 策略管理 自定义认证 SSL证书管理 API测试 凭据管理
API目录 订阅API产品 创建凭证 通过Explorer调试API 父主题: API消费
应用管理 创建应用 管理应用 父主题: 管理中心