检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调试”。 在页面下方返回结果回显区域打印API调用的Response信息。 调用成功时,返回HTTP状态码为“200”和Response信息。 调试失败时,返回HTTP状态码为4xx或5xx,具体错误信息请参考错误码。 您可以通过调整请求参数与参数值,发送不同的请求,验证API服务。
单击“导入用例”,选择导入类型。 导入API服务:从“API服务”中选择API导入,生成测试用例。选择API服务,单击“确定”。 导入API设计文件:从“API设计”选择API导入,生成测试用例。选择API设计文件,单击“确定”。 导入Swagger文件:从用户本地导入API,
Authorization消息头未包含在已签名消息头中,主要用于身份验证。 伪代码如下: Authorization header创建伪码: Authorization: algorithm Access=APP key, SignedHeaders=SignedHeaders
加A类型记录集。 如果API服务中的API支持HTTPS请求协议,那么在独立域名中需要添加SSL证书,请您提前准备SSL证书。此证书不支持导入,您需要填写证书的名称、内容和密钥。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。
在弹窗中选择本地路径下的API设计文件,然后单击“打开”导入文件。 导入的YAML或JSON格式文件大小不能超过3MB,否则将无法导入API服务。 在页面中修改服务名称,或默认系统自动生成的服务名称。 在“API接口”列表勾选需要导入的API,单击“立即导入”。 (可选)单击“全局配置(可选)”,请参考全局配置。
Swagger文档的设计。 API快速实现 ROMA API支持通过导入API文档一键生成代码仓以及流水线,降低开发时间。 API管理 包括API的创建、发布、下线和删除的完整生命周期管理,提供便捷的在线调试能力,支持导入Swagger文档一键生成API,以便更快速地开放API业务。 API策略
置的响应头。 HTTP响应头管理策略 3 SLA配置 提前设计接口运行的可靠性和性能指标。 配置SLA 4 导入规则检查 系统根据默认API导入规则,检测API文件。 导入到API服务 5 后端开发 用户可以快速生成代码,并完成后端的服务能力开发。 后端开发 2021年5月 序号
其他认证:向API管理者获取该API所授权应用的Key和Secret(或客户端的AppKey和AppSecret)或凭证信息。 华为IAM认证:通过云服务平台的账号凭证(账号和密码获取Token或者AK/SK)进行认证。如果使用AK/SK进行认证,还需要向API管理者获取用于调用API的SDK。
导出API服务 您可以把ROMA API上的API服务以YAML或JSON格式导出到本地,用于导入API服务或其他用途。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。
支持以下几种配置方式,用户可根据业务需求选择。 导入示例代码 创建IDEA maven工程 导入示例代码 打开IDEA,在菜单栏选择“File > New > Project from Existing Sources”。 选择解压后的“APIGW-java-sdk-x.x.x”文件夹,单击“OK”,导入示例工程。 在“Import
Java 操作场景 使用Java语言进行后端服务签名时,您需要先获取SDK,然后导入工程,最后参考校验后端签名示例校验签名是否一致。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 前提条件 准备待用的签名密钥的Key和Secret。 已在控制台创建签名密钥,
应,响应类型范围固定不可修改。您可以修改每种响应的状态码,以及响应内容。 响应内容的错误信息以及其他信息,可通过变量的方式获取,支持的变量见表2。 网关错误响应类型说明 ROMA API提供的错误响应类型见表1,其中响应状态码可以按实际需要做自定义修改。 表1 ROMA API的错误响应类型
部署到自己的服务器上。 步骤五:创建API服务 单击“导入到API服务”。 导入前,对API文件进行导入规则检查。 需修复问题,请单击“修复问题”,根据“API Rule Check”提示修改。 无问题修复,请单击“继续导入”。 选择步骤一中实例,填写服务名称,并选择API接口。
在“项目资源”区域,选择您的DevCloud项目,单击“保存”。 单击“创建后端”,选择导入文件类型。 导入API设计文件,从“API设计”中选择设计文件导入,单击“确定”。 导入Swagger文件,从本地导入文件,单击“打开”。 参考下表配置后端。 表1 后端配置参数说明 参数 参数说明
问题。 图1 规范性检查结果 (可选)导入到API服务。 单击“导入到API服务”,系统根据默认API导入规则检测API文件。 如需修复问题,单击“修复问题”根据修改建议修改问题。 图2 API导入规则检查结果 如忽略问题,可单击“继续导入”。 (可选)可视化设计API文件。 单
在“API设计”页面,选择“创建API设计 > 导入Swagger文件”,导入本地API文档。如需通过其他方式创建API设计文档,请参考《用户指南》。 将设计文档封装成API服务。 在“编辑器”页面,单击“导入到API服务”,规则检查通过后,继续导入。 在“导入API设计文件”页面,选择实例并编辑服务名称。
API会对如下字符进行百分号编码:ASCII码为0到31的字符、?、>、<、/、%、#、"、[、\、]、^、`、{、|、}、空白符、ASCII码为127到255的字符。 对于QUERY位置的参数值,ROMA API会对如下字符进行百分号编码:ASCII码为0到31的字符、>、=、<、+、&
相关任务 使用场景 操作步骤 导入到API服务 从API设计文件中挑选部分API接口生成API服务,开放给其他用户使用。 单击对应API设计文件所在行的“导入到API服务”。或单击“编辑器”/“表单”页面中的“导入到API服务”。 导入规则检测通过后,单击“继续导入”。 选择实例,编辑服
Python 操作场景 使用Python语言进行后端服务签名时,您需要先获取SDK,然后导入工程,最后参考校验后端签名示例校验签名是否一致。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 准备环境 准备待用的签名密钥的Key和Secret。 已在控制台创建签
认为检查失败。 间隔时间 连续两次检查的间隔时间,单位为秒。 HTTP响应码 仅当“协议”选择“HTTP”或“HTTPS”时需要配置。 服务器在返回指定的HTTP响应码时,判定响应成功。可同时指定多个响应码。 通道内服务器配置 服务器添加方式 选择添加服务器方式,目前支持“选择云服务器”和“指定服务器地址”。