检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
(可选)按文件夹将API设计文件分类,需要创建文件夹。 单击页面右上角的“创建API设计 > 创建文件夹”,创建一个文件夹。然后单击文件夹名称,进入文件夹。 单击页面右上角的“创建API设计”。 选择“创建API文件”,请参考创建API文件。 选择“导入Swagger文件”,请参考导入Swagger文件。
单击“导入用例”,选择导入类型。 导入API服务:从“API服务”中选择API导入,生成测试用例。选择API服务,单击“确定”。 导入API设计文件:从“API设计”选择API导入,生成测试用例。选择API设计文件,单击“确定”。 导入Swagger文件:从用户本地导入API,
导入Swagger文件”。 在弹窗中选择本地路径下的API设计文件,然后单击“打开”导入文件。 导入的YAML或JSON格式文件大小不能超过3MB,否则将无法导入API服务。 在页面中修改服务名称,或默认系统自动生成的服务名称。 在“API接口”列表勾选需要导入的API,单击“立即导入”。 (
前版本。 导入 API设计文件从本地导入API设计。 在页面中单击API设计文件名称,进入API编辑页面。 单击“编辑器/表单”页签。 单击,导入文件。 导出 API设计文件以YAML或JSON格式导出到本地,用于导入API设计或其他用途。 在页面中单击API设计文件名称,进入API编辑页面。
导出API服务 您可以把ROMA API上的API服务以YAML或JSON格式导出到本地,用于导入API服务或其他用途。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。
在“API设计”页面,选择“创建API设计 > 导入Swagger文件”,导入本地API文档。如需通过其他方式创建API设计文档,请参考《用户指南》。 将设计文档封装成API服务。 在“编辑器”页面,单击“导入到API服务”,规则检查通过后,继续导入。 在“导入API设计文件”页面,选择实例并编辑服务名称。
填写扩展字段的值,显示样式非“文本框”时,配置值必填。 必填 若勾选,表示配置扩展字段时,扩展字段内容不能为空。 显示区域 支持选择扩展字段在设计文件“表单”中显示的区域。 API基本信息 请求参数 数据模型基本信息 数据模型属性 将鼠标移至“显示区域”右侧的问号,单击“了解扩展字段显示区域”查看扩展字段对应区域显示详情。
支持以下几种配置方式,用户可根据业务需求选择。 导入示例代码 创建IDEA maven工程 导入示例代码 打开IDEA,在菜单栏选择“File > New > Project from Existing Sources”。 选择解压后的“APIGW-java-sdk-x.x.x”文件夹,单击“OK”,导入示例工程。 在“Import
下载页面下载。 导入工程 打开IntelliJ IDEA,在菜单栏选择“File > New > Project from Existing Sources”,选择解压后的“apigateway-backend-signature-demo\pom.xml”文件,单击“OK”。 图1
Python 操作场景 使用Python语言进行后端服务签名时,您需要先获取SDK,然后导入工程,最后参考校验后端签名示例校验签名是否一致。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 准备环境 准备待用的签名密钥的Key和Secret。 已在控制台创建签
在“项目资源”区域,选择您的DevCloud项目,单击“保存”。 单击“创建后端”,选择导入文件类型。 导入API设计文件,从“API设计”中选择设计文件导入,单击“确定”。 导入Swagger文件,从本地导入文件,单击“打开”。 参考下表配置后端。 表1 后端配置参数说明 参数 参数说明 后端名称
应用创建完成后,在页面左上角“ROMA API”下切换已创建的应用。 步骤三:创建API设计 在左侧导航栏单击“API设计”。 单击“创建API文件”,选择“导入Swagger文件”导入本地API设计文件。 编辑API,并单击“规范性检查”,按照“Compliance”提示修改内容。 图4 创建API设计 单击“保存”。
置的响应头。 HTTP响应头管理策略 3 SLA配置 提前设计接口运行的可靠性和性能指标。 配置SLA 4 导入规则检查 系统根据默认API导入规则,检测API文件。 导入到API服务 5 后端开发 用户可以快速生成代码,并完成后端的服务能力开发。 后端开发 2021年5月 序号
错误码 用户在调用API失败时,系统返回的错误码包含ROMA和APIG的错误码: 在ROMA实例下,系统返回的错误码请参考错误码。 在APIG实例下,系统返回的错误码请参考错误码。 父主题: 调用API
已备案独立域名,未备案的独立域名无法被访问。 已经将独立的域名解析到该服务的实例IP上,具体方法请参考增加A类型记录集。 如果API服务中的API支持HTTPS请求协议,那么在独立域名中需要添加SSL证书,请您提前准备SSL证书。此证书不支持导入,您需要填写证书的名称、内容和密钥。
Swagger文档的设计。 API快速实现 ROMA API支持通过导入API文档一键生成代码仓以及流水线,降低开发时间。 API管理 包括API的创建、发布、下线和删除的完整生命周期管理,提供便捷的在线调试能力,支持导入Swagger文档一键生成API,以便更快速地开放API业务。 API策略
AK/SK文件,文件名一般为:credentials.csv。 如下图所示,文件包含了租户名(User Name),AK(Access Key Id),SK(Secret Access Key)。 图1 credential.csv文件内容 AK/SK生成步骤: 注册并登录管理控制台。
backend-signature\ 后端签名示例工程 csharp.sln 工程文件 licenses\license-referencesource 第三方库license文件 打开工程 双击SDK包中的“csharp.sln”文件,打开工程。工程中包含如下3个项目: apigateway-si
AUTHORIZER_CONF_FAILURE 500 自定义认证配置错误 自定义认证方异常,通信失败、返回异常响应等错误 AUTHORIZER_FAILURE 500 自定义认证失败 自定义认证方返回认证失败 AUTHORIZER_IDENTITIES_FAILURE 401 自定义认证身份来源错误
获取并安装Visual Studio,如果未安装,请至Visual Studio官方网站下载。 打开工程 双击SDK包中的“csharp.sln”文件,打开工程。工程中包含如下3个项目: apigateway-signature:实现签名算法的共享库,可用于.Net Framework与