检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
将鼠标移至用户名,在下拉列表中单击“我的凭证”。 单击“访问密钥”。 单击“新增访问密钥”,进入“新增访问密钥”页面。 按照界面提示输入验证码或登录密码,单击“确定”,下载密钥,请妥善保管。 生成签名 生成签名的方式和APP认证相同,用AK代替APP认证中的AppKey,SK替换
中级使用者入门指导 作为中级使用者,在线设计API文件和上架API目录,需要完成以下流程: 图1 中级使用者流程图 步骤一:购买实例 在创建应用前,需要先购买实例。 步骤二:创建应用 应用是一个系统资源的集合,下面可以划分不同的服务。 步骤三:创建API设计 快速在线设计标准的RESTful
通过Explorer调试API “Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后,消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API,那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网访问并配置弹性IP,可参考实例配置参数。
创建API设计 ROMA API提供了可视化的API在线设计能力,及接口规范性检查,帮助用户快速设计标准的RESTful API。在开始设计API前,您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。 本地已存在API设计
单击“浏览代码”,查看代码库。代码仓库是代码托管服务存储代码的云端仓库。 单击“在线开发”,通过云端开发环境CloudIDE开发代码,请参考在线开发。 单击“克隆/下载”,克隆或下载代码。 在线开发 单击“在线开发”页签。或在“代码仓”区域,单击“在线开发”。 通过IDE左侧的资源管理器可以看到后端代码的结构,如下所示。
查功能,使用户可以快速、高效的在线进行API Swagger文档的设计。 API快速实现 ROMA API支持通过导入API文档一键生成代码仓以及流水线,降低开发时间。 API管理 包括API的创建、发布、下线和删除的完整生命周期管理,提供便捷的在线调试能力,支持导入Swagge
API提供API产品目录以及订阅系统,API的管理者可将API包装成产品上架到API目录中供其他订阅者使用,订阅者可通过查看API的详细文档以及在线调试来自由的选择需要订阅的API产品。
于PATH和QUERY位置,后端服务通过映射,将在HEADER位置接收test01和test03的值。test02在调用API时配置于HEADER位置,后端服务通过映射,将在PATH位置以参数名test05来接收test02的值。 假设test01为aaa,test02为bbb,test03为ccc。
调试API API创建后需要验证服务是否正常,控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
签名密钥 签名密钥用于后端服务验证API的身份,在API请求后端服务时,保障后端服务的安全。 签名密钥是由一对Key和Secret组成,当签名密钥创建后,ROMA API向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果与
API测试 通过导入API生成测试用例,快速实现API测试覆盖。 使用场景 API上线后,测试API连通性,以及通过定时测试任务来保障API稳定且长效运行。 前提条件 对应实例已绑定弹性IP地址。 已开通测试计划。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
配置网关响应 网关响应指ROMA API未能成功处理API请求,从而产生的错误响应。ROMA API提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API服务管理中新增网关响应,其中响应内容符合JSON格式即可。 例如,“default”网关的响应内容为:
总览 ROMA API是API全生命周期治理经验的产品,如解决从API设计、实现、管理、消费、分析全流程的管理问题。以API流程规范解决企业业务发展过程中遇到的各阶段问题,提供了规范化的产品跟工具支撑,帮助企业快速实现API经济,并持续构建高质量的API服务能力。 图1 API全生命周期
创建负载通道 创建负载通道后,在创建API服务,且后端服务类型为HTTP/HTTPS时,后端服务地址可以直接使用已创建的负载通道。 前提条件 已创建云服务器。如需创建请参考创建云服务器。 已购买实例。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。
分析日志 快速获取并分析API的调用日志。 前提条件 已调用API。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。 单击“日志分析”。
Java 操作场景 使用Java语言调用APP认证的API时,您需要先获取SDK,然后导入示例代码,最后参考调用API示例调用API。 本章节以IDEA为例介绍。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 已
C# 操作场景 使用C#语言进行后端服务签名时,您需要先获取SDK,然后打开工程,最后参考校验后端签名示例校验签名是否一致。 准备环境 准备待用的签名密钥的Key和Secret。 已在控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。 下载SDK的最新版本。 获取并安装Visual
Python 操作场景 使用Python语言进行后端服务签名时,您需要先获取SDK,然后导入工程,最后参考校验后端签名示例校验签名是否一致。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 准备环境 准备待用的签名密钥的Key和Secret。 已在控制台创建签
Java 操作场景 使用Java语言进行后端服务签名时,您需要先获取SDK,然后导入工程,最后参考校验后端签名示例校验签名是否一致。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 前提条件 准备待用的签名密钥的Key和Secret。 已在控制台创建签名密钥,
创建API服务 ROMA API提供了API服务能力,通过API服务把后端服务封装成标准RESTful格式API,并开放给其他用户使用。 目前支持三种创建服务方式: 创建API服务 创建一个简单的服务,不包含API,用户可自行创建API。 导入API设计文件 支持从“API设计”中导入设计文件,同步创建服务。