检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
页面的最左侧展示产品下的API,中间可配置API请求参数,最右侧支持查看调试结果和API文档。 (可选)单击“文档”页签,查看API文档信息。 根据已设置认证方式,编辑请求参数,单击“调试”。
在当前应用关联的实例中,根据实际业务选择实例,查看当前实例下包含的API,以及API基本信息。 单击API名称,查看API详情。 支持批量发布、下线、删除API。 单个支持编辑、调试、授权等操作,可参见APIs管理。 父主题: API管理
调试API API创建后需要验证服务是否正常,控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 操作步骤 登录ROMA API控制台。
删除API API不再提供服务且已下线,可以将API删除。 选择需要删除的API。 选择“更多 > 删除”。 发布历史 查看API发布的历史记录。 选择需要查看的API。 选择“更多 > 发布历史”。 批量操作 批量发布、下线或删除API。
在新建版本中,单击“添加API”,可添加API接口。 编辑 修改产品基本信息。 在API产品所在行,单击“编辑”。 修改产品信息后,单击“完成编辑”。 如果产品已上架,那么需要提交修改申请。 填写申请描述后,单击“确定”。 审核申请通过后,产品信息编辑成功。
API指标分析 云监控对ROMA API的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。
在可视化窗口单击“Show”查看结果,您可以根据“修改建议”修改规范性问题。 (可选)单击“表单”页签。 单击页面右上角“规范性检查”。 在弹窗中查看结果,您可以根据“修改建议”修改规范性问题。 创建Tag 对API接口进行分类处理,方便筛选或查找API接口。
选择API接口,单击“立即导入”,跳转到用例列表页面。 单击用例名称,进入“功能手工测试”页面。 单击“接口自动化”页签,可查看或编辑已创建的测试用例。 单击用例名称,进入“测试详情”页面。 单击“测试脚本”页签。 将鼠标移至测试步骤区域,单击展开。
在页面上单击服务名称,进入API服务详情页面。 单击页面右上角的“导出”。 在页面中配置导出参数,完成后单击“导出”,导出结果可在页面右侧查看,同时支持下载到本地。 表1 API服务导出配置 参数 配置说明 API服务 选择待导出API所在的API服务。
实现API的内部市场 ROMA API提供API产品目录以及订阅系统,API的管理者可将API包装成产品上架到API目录中供其他订阅者使用,订阅者可通过查看API的详细文档以及在线调试来自由的选择需要订阅的API产品。
单击“完成”,进入“API运行”页面,可查看API信息。 后续操作 API创建后,可单击“更多 > 调试”验证服务是否正常,具体操作请参考调试API。 父主题: APIs管理
(可选)规范性检查,对接口规范性检查。 (可选)导入到API服务,将已设计的接口导入API服务。 (可选)可视化设计API文件,对接口可视化设计。 (可选)配置SLA。单击。 需要配置SLA的API所在行,单击“配置SLA”。
若选择“稍后发布”,请参考发布API发布。 单击“确定”,跳转到“API运行”页面,可查看服务下的API。 父主题: API服务管理
设置无需检查的接口 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏单击“API设计”。 在页面右上角单击“API设计配置”。 单击“无需检查的接口”页签。
概述 ROMA API目前提供部分API接口信息。 ROMA实例接口信息请参考:《API参考》。 APIG实例接口信息请参考:《API参考》。
调用API示例 获取Token,并设置成环境变量,Token用于后续调用其他接口鉴权。
图3 上架成功 查看API产品 B部门在“目录列表”中查看API产品。 订阅API B部门在“目录列表”中订阅API产品。 单击“订阅”,填写订阅申请信息。 图4 订阅申请 在“审核管理”页面,选择“我提交的申请”页签,可查看申请详情。
添加规范查询字符串(CanonicalQueryString),以换行符结束。 释义: 查询字符串,即查询参数。如果没有查询参数,则为空字符串,即规范后的请求为空行。
步骤十二:调用API 获取API的请求信息。 在左侧导航栏选择“API消费 > API产品”。 单击步骤九中已建产品名称。 单击已订阅版本号。 单击API名称,查看API接口认证方式、请求方法、URL和请求参数。
1 $curl = $signer->Sign($req); 访问API,查看访问结果。