检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
ROMA API是为API提供全生命周期治理的服务,解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑,解决企业发展过程中各阶段遇到的问题,帮助企业快速实现API经济,持续构建高质量的API服务能力。 表1 产品功能 功能 说明
变更日志 src 验证签名SDK的demo代码,包含WebSocketDemo.java、OkHttpDemo.java、LargeFileUploadDemo.java、HttpClientDemo.java等。 如果使用maven构建,可以使用SDK包中的libs\java-sdk-core-x
打开工程 打开Android Studio,选择“File > Open”。 在弹出的对话框中选择解压后的SDK路径。 打开工程后,目录结构如下。 图1 工程目录结构 调用API示例 在Android工程中的“app/libs”目录下,加入SDK所需jar包。其中jar包必须包括: java-sdk-core-x
C# 操作场景 使用C#语言调用APP认证的API时,您需要先获取SDK,然后打开SDK包中的工程文件,最后参考API调用示例调用API。 准备环境 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 获取并安装Visual S
准备环境 准备待用的签名密钥的Key和Secret。 已在控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。 下载SDK的最新版本。 获取并安装Visual Studio,如果未安装,请至Visual Studio官方网站下载。 打开工程 双击SDK包中的“csharp
Project”对话框,选择“PHP”,单击“Next”。 图2 PHP 单击“...”,在弹出的对话框中选择解压后的SDK路径,单击“Finish”。 图3 选择解压后php的SDK路径 完成工程创建后,目录结构如下。 图4 新建工程php的目录结构 “signer.php”为示例代码,请根据实际情况修改参
创建后端 后端是一种以业务功能为主的服务设计概念,每一个后端都具有自主运行的业务功能。同时,后端支持框架代码的查看、删除,以及源码包的下载功能。 在线开发 后端创建完成后,您可以使用“在线开发”开发代码,通过CodeArts IDE Online修改代码包中的DemoApplication
Project”对话框,选择“Go”,单击“Next”。 图2 Go 单击“...”,在弹出的对话框中选择解压后的SDK路径,单击“Finish”。 图3 选择解压后go的SDK路径 完成工程创建后,目录结构如下。 图4 新建工程go的目录结构 “demo.go”为示例代码,请根据实际情况修改参数后使用。具体代码说明请参考调用API示例。
Web”,单击“Next”。 图2 Static Web 单击“...”,在弹出的对话框中选择解压后的SDK路径,单击“Finish”。 图3 选择解压后JavaScript的SDK路径 完成工程创建后,目录结构如下。 图4 新建工程JavaScript的目录结构 node_demo.js:Nodejs示例
Python 再次单击“Next”,弹出以下对话框。单击“...”,在弹出的对话框中选择解压后的SDK路径,单击“Finish”。 图3 选择解压后的SDK路径 完成工程创建后,目录结构如下。 图4 新建工程python的目录结构 “main.py”为示例代码,请根据实际情况修改参数后使用。具体代码说明请参考调用API示例。
为API绑定流控策略,对API进行流量限制。 步骤七:调试API 您可以在线调试API,确保API的功能正常。 步骤八:绑定域名 创建API服务生成的域名仅用于调试使用,您需要为API服务绑定独立的访问域名。 步骤九:创建产品 将已创建的API服务生成产品。 步骤十:上架目录 将生成的产品上架到目录中,供消费者查看和订阅。
path”,“Target”选择工程下的“backend_signature.py”文件,单击“OK”,完成工程配置。 校验后端签名示例 示例演示如何编写一个基于Flask的服务器,作为API的后端,并且实现一个wrapper,对API网关(即API管理)的请求做签名校验。 API绑定签
选择待导出API所在的API服务。 运行环境 选择待导出API所在的部署环境。 API 默认导出API服务在所选择环境下的所有API。如果只需要导出个别API,可单击“自定义导出API”,勾选需要导出的API。 API定义范围 选择导出的API服务文件中,API定义字段的类型范围。 基础定义
示例。 校验后端签名示例 示例演示如何编写一个基于Spring boot的服务器,作为API的后端,并且实现一个Filter,对API网关(即API管理)的请求做签名校验。 API绑定签名密钥后,发给后端的请求中才会添加签名信息。 编写一个Controller,匹配所有路径和方法,返回体为“Hello
仅当“协议”选择“HTTP”或“HTTPS”时需要配置。 选择健康检查所使用的HTTP请求方法,可选择“GET”和“HEAD”。 高级设置 检查端口 健康检查的目标端口,默认使用负载通道配置的端口号,但您可以指定其他的端口。 正常阈值 执行健康检查时,判定服务器状态正常的连续检查成功次数。例如“正常阈值”设置为“
、灵活的实现API的跨域访问。 使用限制 已了解前提条件。 同一API服务下,相同请求路径的所有API,只能绑定同一个跨域资源共享策略。 若API开启了“支持CORS”功能的同时,也绑定了跨域资源共享策略,则以绑定的策略为准。 若某个请求路径下有OPTIONS方法的API,则该请
配置跨域访问API 出于安全性考虑,浏览器会限制从页面脚本内发起的跨域请求,此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 浏览器将CORS请求分为两类 简单请求 非简单请求 详情请参考配置跨域访问API。 父主题:
不论“default(默认)”或是您自定义的网关响应,响应类型范围固定不可修改。您可以修改每种响应的状态码,以及响应内容。 响应内容的错误信息以及其他信息,可通过变量的方式获取,支持的变量见表2。 网关错误响应类型说明 ROMA API提供的错误响应类型见表1,其中响应状态码可以按实际需要做自定义修改。
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 单击“客户端”右下方的加号,然后单击“跨域资源共享”。 图1
API指标分析 云监控对ROMA API的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析