检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
要创建文件夹。 单击页面右上角的“创建API设计 > 创建文件夹”,创建一个文件夹。然后单击文件夹名称,进入文件夹。 单击页面右上角的“创建API设计”。 选择“创建API文件”,请参考创建API文件。 选择“导入Swagger文件”,请参考导入Swagger文件。 选择“批量导
中级使用者入门指导 作为中级使用者,在线设计API文件和上架API目录,需要完成以下流程: 图1 中级使用者流程图 步骤一:购买实例 在创建应用前,需要先购买实例。 步骤二:创建应用 应用是一个系统资源的集合,下面可以划分不同的服务。 步骤三:创建API设计 快速在线设计标准的RESTful
导入规则检测通过后,单击“继续导入”。 选择实例,编辑服务名称,选择API接口,单击“立即导入”。 (可选)服务全局配置具体操作步骤请参考导入API设计文件。 重命名 修改API设计文件名称。 单击对应API设计文件所在行的“重命名”,即可修改名称。 删除 删除API设计文件。 单
成测试用例。选择API服务,单击“确定”。 导入API设计文件:从“API设计”选择API导入,生成测试用例。选择API设计文件,单击“确定”。 导入Swagger文件:从用户本地导入API,生成测试用例。选择API文件,单击“打开”。 配置用例参数。 表1 用例参数 参数 配置说明
创建API服务 创建一个简单的服务,不包含API,用户可自行创建API。 导入API设计文件 支持从“API设计”中导入设计文件,同步创建服务。 导入Swagger文件 从本地导入已有的API设计文件,同步创建服务。 创建API服务 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
产品优势 全自动化设计规范检测 从设计者体验和效率出发,提供一款便捷的API编辑器,支持标准Swagger的编辑能力和通俗易懂的表单编辑能力,并融入华为10年累积的API治理规范标准,实现全自动化检测,提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约,自动
通过Explorer调试API “Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后,消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API,那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网访问并配置弹性IP,可参考实例配置参数。
在“项目资源”区域,选择您的DevCloud项目,单击“保存”。 单击“创建后端”,选择导入文件类型。 导入API设计文件,从“API设计”中选择设计文件导入,单击“确定”。 导入Swagger文件,从本地导入文件,单击“打开”。 参考下表配置后端。 表1 后端配置参数说明 参数 参数说明 后端名称
API设计配置 ROMA API提供了API设计文件规范性检查,帮助用户快速设计标准的RESTful API。您可以选择已有的规则集或者新建规则集对API设计文件进行规范性检查。 ROMA API也支持配置扩展字段,您按照Swagger规范性设计API的同时,也可额外自定义扩展字段。
HTTP响应头管理策略 3 SLA配置 提前设计接口运行的可靠性和性能指标。 配置SLA 4 导入规则检查 系统根据默认API导入规则,检测API文件。 导入到API服务 5 后端开发 用户可以快速生成代码,并完成后端的服务能力开发。 后端开发 2021年5月 序号 功能名称 功能描述
在“API设计”页面,选择“创建API设计 > 导入Swagger文件”,导入本地API文档。如需通过其他方式创建API设计文档,请参考《用户指南》。 将设计文档封装成API服务。 在“编辑器”页面,单击“导入到API服务”,规则检查通过后,继续导入。 在“导入API设计文件”页面,选择实例并编辑服务名称。 进入“全局配置(可选)”页面,并发布。
backend-signature\ 后端签名示例工程 csharp.sln 工程文件 licenses\license-referencesource 第三方库license文件 打开工程 双击SDK包中的“csharp.sln”文件,打开工程。工程中包含如下3个项目: apigateway-si
sdk.zip”压缩包,解压后目录结构如下: 名称 说明 app\ 安卓工程代码 gradle\ gradle相关文件 build.gradle gradle配置文件 gradle.properties settings.gradle gradlew gradle wrapper执行脚本
找到原来已下载的AK/SK文件,文件名一般为:credentials.csv。 如下图所示,文件包含了租户名(User Name),AK(Access Key Id),SK(Secret Access Key)。 图1 credential.csv文件内容 注意事项: 每个用户最
以文本方式打开待添加证书里的PEM格式证书文件(后缀名为“.pem”),将证书内容复制到“证书内容”中即可。 若证书为非pem编码格式,可参考转换证书为PEM格式进行证书格式转换。 密钥 填写pem编码格式的SSL证书密钥。 以文本方式打开待上传证书里的KEY格式或PEM格式的私钥文件(后缀名为“.pem”或“
查功能,使用户可以快速、高效的在线进行API Swagger文档的设计。 API快速实现 ROMA API支持通过导入API文档一键生成代码仓以及流水线,降低开发时间。 API管理 包括API的创建、发布、下线和删除的完整生命周期管理,提供便捷的在线调试能力,支持导入Swagge
在弹窗中单击“New Window”。 把示例工程中的“src”和“libs”文件夹复制到apig-sdk-maven-demo工程下。 配置新建Maven工程的pom.xml文件。 在左侧展开工程文件,双击“pom.xml”将以下内容复制粘贴替换原有内容。 打包时依赖包需要下载安装到本地仓库进行打包。
错误响应类型 默认的响应状态码 错误说明 详细说明 ACCESS_DENIED 403 拒绝访问 拒绝访问,如触发配置的访问控制策略、或异常攻击检测拦截 AUTHORIZER_CONF_FAILURE 500 自定义认证配置错误 自定义认证方异常,通信失败、返回异常响应等错误 AUTHORIZER_FAILURE
默认导出API服务在所选择环境下的所有API。如果只需要导出个别API,可单击“自定义导出API”,勾选需要导出的API。 API定义范围 选择导出的API服务文件中,API定义字段的类型范围。 基础定义:包括API前端请求定义和响应定义,不包括后端服务定义。其中API前端请求定义除了Swagger规
API提供API产品目录以及订阅系统,API的管理者可将API包装成产品上架到API目录中供其他订阅者使用,订阅者可通过查看API的详细文档以及在线调试来自由的选择需要订阅的API产品。