检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
选择需要上架的API产品,单击产品名称。 在“版本列表”中,选择上架版本,单击“上架”。 填写上架申请,单击“确定”。 审核申请通过后,产品上架成功。 后续操作 如需实现创建新版本、下架、不推荐等操作,请参考管理API产品。 父主题: API产品
速、低成本、低风险的实现内部系统集成、成熟业务能力开放及业务能力变现。 使用场景 ROMA Connect实例: 需要解决跨网及多云API业务集成 需要使用丰富的API编排跟数据API服务能力 需要拥有更高的性能跟全栈的应用集成能力 APIG实例: 需要实现API的开放托管,安全等配置
ROMA API是API全生命周期治理经验的产品,如解决从API设计、实现、管理、消费、分析全流程的管理问题。以API流程规范解决企业业务发展过程中遇到的各阶段问题,提供了规范化的产品跟工具支撑,帮助企业快速实现API经济,并持续构建高质量的API服务能力。 图1 API全生命周期
基本概念 应用 API的全生命周期管理在应用中实现,应用是一个系统资源的集合,即多个区域下,多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管
少个用例。 用例等级 L0:最基本的功能验证。 L1:基本功能验证,可用于继承特性的基本功能验证、迭代验收前的基本功能验证等。 L2:重要特性验证,可用于测试版本(非回归版本)中功能测试。 L3:一般功能/非重要功能验证,包括对基本/重要功能的异常测试。 L4:非常特殊输入、场景、阈值条件的用例。
”拼接后,再添加当前响应头的值。 当API响应中不存在指定的响应头时,添加当前响应头。 delete:删除 当API响应中存在指定的响应头时,删除当前响应头。 当API响应中存在多个与指定响应头相同名称的响应头时,删除所有相同名称的响应头。 skip:跳过 当API响应中存在指定的响应头时,跳过当前响应头。
范标准,实现全自动化检测,提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约,自动生成API框架代码和测试用例,依托CICD(Continuous Integration Continuous Delivery持续集成)能力高效完成产品研发,并实现开发、测试
仅当“后端认证”选择“自定义认证”时可配置。 需要先创建自定义认证,自定义认证通过函数服务实现,在函数服务中编写一个函数,实现您的认证鉴权流程,或者使用函数调用您的统一鉴权服务。 说明: 后端认证依赖函数服务,此功能仅在部分区域开放。 支持跨域CORS 配置API是否支持跨域访问CORS。 CORS请求分为两类:
出于安全性考虑,浏览器会限制从页面脚本内发起的跨域请求,此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 浏览器将CORS请求分为两类 简单请求 非简单请求 详情请参考配置跨域访问API。 父主题: 调用API
描述 关于控制策略的描述。 单击“确定”。 步骤七:调试API 单击“调试”。 填写请求参数,单击“调试”。 在页面下方显示请求消息和响应结果,若调试成功,状态码显示“200”。 图7 调试 步骤八:绑定域名 单击“基本信息”页签。 在“域名管理”区域,单击“绑定独立域名”。 填写域名配置信息。
当今企业随着系统内部功能逐渐增多,子系统数量成倍增长,各个系统间调用依赖愈发重要,此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器,通过规范化、标准化的API文档形成稳定资产,快速完成内部系统对外接口的统一,有效降低开发成本。 实现API的内部市场
浏览器出于安全性考虑,会限制从页面脚本内发起的跨域访问(CORS)请求,此时页面只能访问同源的资源,而CORS允许浏览器向跨域服务器,发送XMLHttpRequest请求,从而实现跨域访问。 前提条件 API已发布。 配置跨域访问控制 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。
约束与限制 约束限制 功能模块 限制条件 API设计 无 API实现 应用需关联CodeArts项目 API管理(除API测试) 应用需关联APIG实例/ROMA Connect实例 API测试 应用需关联CodeArts项目 API消费 无 API分析 应用需关联APIG实例/ROMA
2021年5月 序号 功能名称 功能描述 相关文档 1 全局APP 应用支持多区域、多资源管理。 应用管理 2 审核管理 为产品上架/不推荐/下架过程提供审核机制,让更多用户参与到API产品审视中,以确保产品的正确性。 审核管理 2021年4月 序号 功能模块 功能描述 相关文档 1
通过Explorer调试API “Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后,消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API,那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网
API将服务或数据变现,内部之间相互调用实现资源共享。 例如,部门A在ROMA API开放API,设计API、生成产品并上架到API目录,部门B通过API目录查看和订阅API。此时,部门A通过开放业务能力,使自身服务能力变现,部门B直接订阅部门A开放的API,减少开发时间和成本,实现部门之间业务共享。
计费说明 ROMA API本身不收费,但需先关联资源才可使用对应功能。请参考: 专享版APIG计费说明 ROMA Connect计费说明 CodeArts计费说明
RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 当创建API时定义了变量标识,则需要在环境中添加变量。例如创建API时定义了变量名为“Pa
则开启后端认证。 后端认证需要先添加一个自定义认证,自定义认证通过函数服务实现,在函数服务中编写一个函数,实现您的认证鉴权流程,或者使用函数调用您的统一鉴权服务。 说明: 后端认证依赖函数服务,此功能仅在部分区域开放。 表5 FunctionGraph类型定义后端服务 服务参数
单击“重置Secret”重置即可。注意重置后无法恢复,请谨慎操作。 编辑凭证 如需修改凭证信息,单击“编辑凭证”即可。 删除凭证 如需删除凭证信息,单击“删除凭证”即可。 取消订阅 单击“取消订阅”,取消通过该凭证订阅的API产品。 父主题: API目录