检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
通过Explorer调试API “Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后,消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API,那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网访问并配置弹性IP,可参考实例配置参数。
在弹窗中选择本地路径下的API设计文件包,单击“打开”导入文件包。 导入的YAML或JSON格式文件内容应满足Swagger 2.0规范定义。 导入的zip压缩包大小不能超过1MB,单个YAML或JSON格式文件中内容不能超过1024000个字符(包括空格),否则将无法导入设计文件。
单击,导入文件。 导出 API设计文件以YAML或JSON格式导出到本地,用于导入API设计或其他用途。 在页面中单击API设计文件名称,进入API编辑页面。 单击“编辑器/表单”页签。 根据需要导出文件的格式,单击,选择“导出YAML/导出JSON”导出文件。 Mock调测 对API设计文件的接口地址进行调测。
导出API服务 您可以把ROMA API上的API服务以YAML或JSON格式导出到本地,用于导入API服务或其他用途。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。
单击页面右上角的“创建API服务 > 导入Swagger文件”。 在弹窗中选择本地路径下的API设计文件,然后单击“打开”导入文件。 导入的YAML或JSON格式文件大小不能超过3MB,否则将无法导入API服务。 在页面中修改服务名称,或默认系统自动生成的服务名称。 在“API接口”列表勾选需要导入的API,单击“立即导入”。
API提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API服务管理中新增网关响应,其中响应内容符合JSON格式即可。 例如,“default”网关的响应内容为: {"error_code": "$context.error.code", "error_msg":
查功能,使用户可以快速、高效的在线进行API Swagger文档的设计。 API快速实现 ROMA API支持通过导入API文档一键生成代码仓以及流水线,降低开发时间。 API管理 包括API的创建、发布、下线和删除的完整生命周期管理,提供便捷的在线调试能力,支持导入Swagge
独立域名:您自定义的域名,API调用者通过访问独立域名来调用您开放的API。 前提条件 已备案独立域名,未备案的独立域名无法被访问。 已经将独立的域名解析到该服务的实例IP上,具体方法请参考增加A类型记录集。 如果API服务中的API支持HTTPS请求协议,那么在独立域名中需要添加SSL证书
query = { "a":"1","b":"2" } r.headers = { "Content-Type":"application/json" } var opts = sig.Sign(r) var scheme = "https" $.ajax({ type: opts
Url=https://c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com 填入json格式的Query和Headers,填入Body。 单击“Send request”,生成curl命令。将curl命令复制到命令行,访问API。
request = new RequestWrapper((HttpServletRequest) servletRequest); 使用正则表达式解析Authorization头,得到signingKey和signedHeaders。 1 2 3 4 5 6 7 8 9
单击“浏览代码”,查看代码库。代码仓库是代码托管服务存储代码的云端仓库。 单击“在线开发”,通过云端开发环境CloudIDE开发代码,请参考在线开发。 单击“克隆/下载”,克隆或下载代码。 在线开发 单击“在线开发”页签。或在“代码仓”区域,单击“在线开发”。 通过IDE左侧的资源管理器可以看到后端代码的结构,如下所示。
return wrapped return wrapper wrapped函数为签名校验代码。校验流程如下:使用正则表达式解析Authorization头。得到key和signedHeaders。 1 2 3 4 5 6 7 8 if "authorization"
HttpClientDemo - Processing Header with name: Content-Type and value: application/json [main] INFO com.huawei.apig.sdk.demo.HttpClientDemo - Processing Header
HTTP/1.1 Host: service.region.example.com Content-Type: application/json x-sdk-date: 20190329T074551Z X-Stage: DEVELOP 创建环境变量 登录ROMA API控制台。
6f-a8655461897e.apigw.exampleRegion.com\n Content-Type: application/json;charset=utf8\n My-header1: a b c \n X-Sdk-Date:20191111T093443Z\n
API提供API产品目录以及订阅系统,API的管理者可将API包装成产品上架到API目录中供其他订阅者使用,订阅者可通过查看API的详细文档以及在线调试来自由的选择需要订阅的API产品。
https://{iam_endpoint}/v3/auth/tokens -H 'content-type: application/json' -d '{ "auth": { "identity": { "methods": [ "password"
... } } } OnAuthorization函数为签名校验代码。校验流程如下:使用正则表达式解析Authorization头。得到key和signedHeaders。 1 2 3 4 5 6 7 8 9 10 11 12
中级使用者入门指导 作为中级使用者,在线设计API文件和上架API目录,需要完成以下流程: 图1 中级使用者流程图 步骤一:购买实例 在创建应用前,需要先购买实例。 步骤二:创建应用 应用是一个系统资源的集合,下面可以划分不同的服务。 步骤三:创建API设计 快速在线设计标准的RESTful