检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API消费 API产品 API目录 审核管理 调用API
当今企业随着系统内部功能逐渐增多,子系统数量成倍增长,各个系统间调用依赖愈发重要,此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器,通过规范化、标准化的API文档形成稳定资产,快速完成内部系统对外接口的统一,有效降低开发成本。 实现API的内部市场
API设计 创建API设计 API设计配置 管理API设计
API实现 创建后端
API分析 API指标分析
API产品 创建API产品 上架目录 管理API产品 父主题: API消费
提供如何在API的描述信息中使用markdown语法,使描述信息更直观。 SimpleBookManagementAPI 提供资源管理类的简单API样例。 FileOperation 提供如何定义文件操作类API的简单样例。 Petstore 提供多种复杂API的定义样例。 单击“
API目录 订阅API产品 创建凭证 通过Explorer调试API 父主题: API消费
调用API 调用已发布的API 配置跨域访问API 错误码 父主题: API消费
sln”文件,打开工程。工程中包含如下3个项目: apigateway-signature:实现签名算法的共享库,可用于.Net Framework与.Net Core项目。 backend-signature:后端服务签名示例。 sdk-request:签名算法的调用示例,请根据实际情况修改参数后使用。具体代码说明请参考调用API示例。
path”,“Target”选择工程下的“backend_signature.py”文件,单击“OK”,完成工程配置。 校验后端签名示例 示例演示如何编写一个基于Flask的服务器,作为API的后端,并且实现一个wrapper,对API网关(即API管理)的请求做签名校验。 API绑定签
校验后端签名示例 示例演示如何编写一个基于ASP.Net Core的服务器,作为API的后端,并且实现一个IAuthorizationFilter,对API网关(即API管理)的请求做签名校验。 API绑定签名密钥后,发给后端的请求中才会添加签名信息。 编写一个Controller,提供
错误码 用户在调用API失败时,系统返回的错误码包含ROMA和APIG的错误码: 在ROMA实例下,系统返回的错误码请参考错误码。 在APIG实例下,系统返回的错误码请参考错误码。 父主题: 调用API
给请求添加x-stage头,内容为环境名。如果有需要,添加需要签名的其他头域。 request->addHeader("x-stage", "RELEASE"); 进行签名,执行此函数会将生成的签名头加入request变量中。 signer.createSignature(request); 使用curl库访问API,查看访问结果。
参数说明 后端名称 后端的名称。 归属项目 自动读取当前应用已关联Devcloud服务中的项目。 新建代码仓 设置后端代码保存的代码仓库名称,请不要跟该项目下已有代码仓库重名。 新建流水线 选择使用的流水线,当前仅支持在官方提供的流水线中选择。当前提供的流水线为手动触发流水线,在
C 操作场景 使用C语言调用APP认证的API时,您需要先获取SDK,参考API调用示例调用API。 准备环境 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 安装openssl库。 apt-get install libssl-dev
tapestry:quickstart”。 JDK:用户自己的版本。 IDEA支持在当前窗口或新窗口创建工程。此处,在弹窗中单击“New Window”。 把示例工程中的“src”和“libs”文件夹复制到apig-sdk-maven-demo工程下。 配置新建Maven工程的pom.xml文件。 在左侧展开工程文件,双击“pom
打开工程 打开Android Studio,选择“File > Open”。 在弹出的对话框中选择解压后的SDK路径。 打开工程后,目录结构如下。 图1 工程目录结构 调用API示例 在Android工程中的“app/libs”目录下,加入SDK所需jar包。其中jar包必须包括: java-sdk-core-x
APP认证凭证:选择已创建凭证,可选择的凭证是已使用凭证订阅了API所在产品的凭证。 填写API的Headers参数。 填写API的Params参数。 已定义Body 通过切换输入方式可以选择表单填写或文本输入请求体。 未定义Body 通过POST/PUT/PATCH方法请求的API支持展示自定义填写。 说明:
Signature=9e5314bd156d517******dd3e5765fdde4" -d "" Congratulations, sdk demo is running SDK生成的curl命令不符合Window下cmd终端格式,请在git bash下执行生成的curl命令。