检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
C# 操作场景 使用C#语言调用APP认证的API时,您需要先获取SDK,然后打开SDK包中的工程文件,最后参考API调用示例调用API。 准备环境 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 获取并安装Visual S
统显得极为关键。ROMA API提供可视化的API文档编辑器,通过规范化、标准化的API文档形成稳定资产,快速完成内部系统对外接口的统一,有效降低开发成本。 实现API的内部市场 ROMA API提供API产品目录以及订阅系统,API的管理者可将API包装成产品上架到API目录中
ROMA API是为API提供全生命周期治理的服务,解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑,解决企业发展过程中各阶段遇到的问题,帮助企业快速实现API经济,持续构建高质量的API服务能力。 表1 产品功能 功能 说明
API产品是从服务中挑选想要共享的API组合而成,即为将要上架的API的集合。 新建API产品 创建新的API产品。 添加API到产品 为已创建的API产品添加API。 新建API产品 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费
实现开发、测试、运行的并行操作,大大提升了产品的研发效率。 多重运行安全防护 API的开放无时无刻都在面临着巨大的安全攻击风险(DDoS、XSS、钓鱼、暴力攻击等),ROMA API提供了一套完善的4层防护架构,从接入层、认证层、审计层和转发层,层层保障您的后端安全。 接入层 基
生成一个新的Signer, 填入AppKey和AppSecret。 Signer signer("4f5f626b-073f-402f-a1e0-e52171c6100c", "******"); 生成一个新的RequestParams,指定方法名、域名、请求uri、查询字符串和body。
ROMA API支持把API服务中的API资源作为一个产品,共享给其他用户使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。
加需要签名的其他头域。 sig_headers_add(¶ms.headers, "x-stage", "RELEASE"); 进行签名,执行此函数会将生成的签名头加入request变量中。 sig_sign(¶ms); 使用curl库访问API,查看访问结果。 static
不论“default(默认)”或是您自定义的网关响应,响应类型范围固定不可修改。您可以修改每种响应的状态码,以及响应内容。 响应内容的错误信息以及其他信息,可通过变量的方式获取,支持的变量见表2。 网关错误响应类型说明 ROMA API提供的错误响应类型见表1,其中响应状态码可以按实际需要做自定义修改。
Project”对话框,选择“Go”,单击“Next”。 图2 Go 单击“...”,在弹出的对话框中选择解压后的SDK路径,单击“Finish”。 图3 选择解压后go的SDK路径 完成工程创建后,目录结构如下。 图4 新建工程go的目录结构 “demo.go”为示例代码,请根据实际情况修改参数后使用。具体代码说明请参考调用API示例。
、灵活的实现API的跨域访问。 使用限制 已了解前提条件。 同一API服务下,相同请求路径的所有API,只能绑定同一个跨域资源共享策略。 若API开启了“支持CORS”功能的同时,也绑定了跨域资源共享策略,则以绑定的策略为准。 若某个请求路径下有OPTIONS方法的API,则该请
配置跨域访问API 出于安全性考虑,浏览器会限制从页面脚本内发起的跨域请求,此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 浏览器将CORS请求分为两类 简单请求 非简单请求 详情请参考配置跨域访问API。 父主题:
Connect开放给用户调用。API包括基本信息、前后端的请求路径和参数以及请求相关协议。 API服务 API服务是同一种业务API的集合,API开发者以API服务为单位,管理服务内的所有API。 API产品 API产品是从服务中挑选想要共享的API组合而成,即为将要上架的API的集合。 API目录 API目
配置环境和环境变量 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境
Python 再次单击“Next”,弹出以下对话框。单击“...”,在弹出的对话框中选择解压后的SDK路径,单击“Finish”。 图3 选择解压后的SDK路径 完成工程创建后,目录结构如下。 图4 新建工程python的目录结构 “main.py”为示例代码,请根据实际情况修改参数后使用。具体代码说明请参考调用API示例。
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 单击“客户端”右下方的加号,然后单击“跨域资源共享”。 图1
示例。 校验后端签名示例 示例演示如何编写一个基于Spring boot的服务器,作为API的后端,并且实现一个Filter,对API网关(即API管理)的请求做签名校验。 API绑定签名密钥后,发给后端的请求中才会添加签名信息。 编写一个Controller,匹配所有路径和方法,返回体为“Hello
path”,“Target”选择工程下的“backend_signature.py”文件,单击“OK”,完成工程配置。 校验后端签名示例 示例演示如何编写一个基于Flask的服务器,作为API的后端,并且实现一个wrapper,对API网关(即API管理)的请求做签名校验。 API绑定签
准备环境 准备待用的签名密钥的Key和Secret。 已在控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。 下载SDK的最新版本。 获取并安装Visual Studio,如果未安装,请至Visual Studio官方网站下载。 打开工程 双击SDK包中的“csharp
后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。