检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API目录 订阅API产品 创建凭证 通过Explorer调试API 父主题: API消费
API的全生命周期管理在应用中实现,应用是一个系统资源的集合,即多个区域下,多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管理提供了API服务
API产品 创建API产品 上架目录 管理API产品 父主题: API消费
规则,可单击“管理”或“查看”。 管理:自己创建的规则集支持查看和编辑。 查看:其他用户创建的规则集仅支持查看。 通过“问题级别”和“规则类型”选择性查看。 单击规则名称,可查看规则的“正确示例”和“错误示例”。 (可选)编辑规则集,可单击“管理”或“编辑”。 管理:配置规则。 取消已启用规则
API指标分析 云监控对ROMA API的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
调用API 调用已发布的API 配置跨域访问API 错误码 父主题: API消费
开发。 单击“克隆/下载”,克隆或下载代码。 在线开发 单击“在线开发”页签。或在“代码仓”区域,单击“在线开发”。 通过IDE左侧的资源管理器可以看到后端代码的结构,如下所示。 |--src |--main |--java 这个目录下的文件夹结构与模板参数中的“package
SDK概述 本文介绍了ROMA API提供的开放API的SDK语言版本,列举了最新版本SDK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表,您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言
定资产,快速完成内部系统对外接口的统一,有效降低开发成本。 实现API的内部市场 ROMA API提供API产品目录以及订阅系统,API的管理者可将API包装成产品上架到API目录中供其他订阅者使用,订阅者可通过查看API的详细文档以及在线调试来自由的选择需要订阅的API产品。
产品规格差异 ROMA API无具体规格指标,请参考: APIG专享版产品规格说明 ROMA Connect产品规格说明 CodeArts产品规格说明
DescriptionWithGFM 提供如何在API的描述信息中使用markdown语法,使描述信息更直观。 SimpleBookManagementAPI 提供资源管理类的简单API样例。 FileOperation 提供如何定义文件操作类API的简单样例。 Petstore 提供多种复杂API的定义样例。
已在本地PC上下载并安装接口调试工具。 步骤一:购买实例 选择实例类型。 登录ROMA API控制台,单击,选择区域。 在左侧导航栏选择“管理中心 > 实例管理”。 单击“购买实例”。 选择实例类型,以APIG实例为例。 购买实例。 创建APIG实例。 图2 配置实例信息 表1 配置实例信息
创建API产品 API产品是从服务中挑选想要共享的API组合而成,即为将要上架的API的集合。 新建API产品 创建新的API产品。 添加API到产品 为已创建的API产品添加API。 新建API产品 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。
在弹框中选择版本号和凭证,填写申请描述。 您可以使用已有的凭证或者新建凭证,新建凭证具体操作请参考创建凭证。 单击“确定”,订阅申请成功。 在左侧导航栏单击“审核管理”,审核申请通过后,订阅产品完成。 父主题: API目录
创建凭证 凭证代表用户认证标识,用户通过凭证来订阅上架的产品,订阅后方可调用对应产品下的API。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击“订阅与凭证”页签。
在“版本列表”中,选择上架版本,单击“上架”。 填写上架申请,单击“确定”。 审核申请通过后,产品上架成功。 后续操作 如需实现创建新版本、下架、不推荐等操作,请参考管理API产品。 父主题: API产品
应用状态显示异常是什么原因? 应用的状态基于应用关联的资源状态来显示: 应用关联的ROMA/APIG实例状态异常,或者关联ROMA集成应用不存在时,应用资源会变成异常状态。 有一个应用资源状态显示异常,整个应用的状态就会显示异常。 修复或移除对应的异常资源,应用状态会恢复正常。
错误码 用户在调用API失败时,系统返回的错误码包含ROMA和APIG的错误码: 在ROMA实例下,系统返回的错误码请参考错误码。 在APIG实例下,系统返回的错误码请参考错误码。 父主题: 调用API
配置跨域访问API 出于安全性考虑,浏览器会限制从页面脚本内发起的跨域请求,此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 浏览器将CORS请求分为两类 简单请求 非简单请求 详情请参考配置跨域访问API。 父主题:
进入产品详情页面,提交上架申请。 图1 提交上架申请 在“审核管理”页面,选择“我提交的申请”页签,可查看申请详情。 在“审核管理”页面,选择“我审核的申请”页签,单击“查看详情”,审批产品信息。 仅支持拥有租户管理员权限者审批。 图2 审批申请 查看上架是否成功。 返回产品详情页面,查看版本是否上架成功。