检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
0支持ROMA API ROMA API为企业构建规范化的API全流程体系,将企业服务能力包装成标准API服务,上架市场进行售卖。变现自身服务能力的同时,降低企业研发投入,专注于企业核心业务,提升运营效率。提供全栈的API数据化运营能力,用运行数据驱动规范跟设计的落地,提供更高维度的顶层API架构设计能力。
产品优势 全自动化设计规范检测 从设计者体验和效率出发,提供一款便捷的API编辑器,支持标准Swagger的编辑能力和通俗易懂的表单编辑能力,并融入华为10年累积的API治理规范标准,实现全自动化检测,提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约,自动
API设计配置 ROMA API提供了API设计文件规范性检查,帮助用户快速设计标准的RESTful API。您可以选择已有的规则集或者新建规则集对API设计文件进行规范性检查。 ROMA API也支持配置扩展字段,您按照Swagger规范性设计API的同时,也可额外自定义扩展字段。 您可以进行以下操作:
API是API全生命周期治理经验的产品,如解决从API设计、实现、管理、消费、分析全流程的管理问题。以API流程规范解决企业业务发展过程中遇到的各阶段问题,提供了规范化的产品跟工具支撑,帮助企业快速实现API经济,并持续构建高质量的API服务能力。 图1 API全生命周期 本手册
建议”修改规范性问题。 (可选)单击“表单”页签。 单击页面右上角“规范性检查”。 在弹窗中查看结果,您可以根据“修改建议”修改规范性问题。 创建Tag 对API接口进行分类处理,方便筛选或查找API接口。 在页面中单击API设计文件名称,进入API编辑页面。 单击“表单”页签。
单击实例名称或实例卡片右上角的“查看控制台”。 单击“负载通道”页签。 单击“创建负载通道”。 根据下表参数说明,配置通道信息。 表1 负载通道参数说明 参数类型 参数项 说明 基本信息 通道名称 填写负载通道的名称,根据规划自定义。建议您按照一定的命名规则填写负载通道名称,方便您快速识别和查找。 端口 填写负载通道的服务器访问端口号。
API提供了规范化的产品和工具支撑,解决企业发展过程中各阶段遇到的问题,帮助企业快速实现API经济,持续构建高质量的API服务能力。 表1 产品功能 功能 说明 API可视化设计 ROMA API集成了标准的Swagger编辑器,支持编辑器编辑和表单编辑两种方式,并提供规范性检查功能,使用户可以快速、高效的在线进行API
址,您可以在可视化窗口对接口地址进行调测。 (可选)规范性检查。 在规范性检查之前,您需提前启用规则集或创建规则集。在编辑窗口上方单击“规范性检查”,检查结果在可视化视图窗口查看,您可以根据修改建议修改规范性问题。 图1 规范性检查结果 (可选)导入到API服务。 单击“导入到A
API列表 API列表支持查看当前实例下所有的API,包含URL、运行环境、安全认证信息。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API列表”。 在当前应用关联的实例中,根据实
在当前应用关联的实例中,根据实际业务选择实例。 在“SSL证书管理”页面,单击“创建SSL证书”。 表1 SSL证书配置 参数 配置说明 证书名称 填写SSL证书的名称,根据规划自定义。建议您按照一定的命名规则填写SSL证书名称,方便您快速识别和查找。 证书内容 填写pem编码格式的SSL证书内容。
配置实例信息 表1 配置实例信息 参数 配置说明 计费模式 选择实例的计费模式,此处选择“按需计费”。 区域 选择实例所在的区域,此处选择“华北-北京四”。 可用区 选择实例所在的可用区,此处选择“可用区1”。 实例名称 填写实例的名称,根据规划自定义。建议您按照一定的命名规则填写实例名称,方便您快速识别和查找。
应用场景 企业API文档规范统一 当今企业随着系统内部功能逐渐增多,子系统数量成倍增长,各个系统间调用依赖愈发重要,此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器,通过规范化、标准化的API文档形成稳定资产,快速完成内部系统对外接口的统一,有效降低开发成本。
传统策略:流量控制、访问控制和签名密钥。 单击“创建策略”,配置策略信息。 插件策略请参考下表配置: 表1 插件策略配置 参数 配置说明 策略名称 填写策略的名称,根据规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。 策略类型 选择策略的类型,不同类型的策略提供不同扩展能力。
在页面上单击服务名称,进入API服务详情页面。 单击页面右上角的“导出”。 在页面中配置导出参数,完成后单击“导出”,导出结果可在页面右侧查看,同时支持下载到本地。 表1 API服务导出配置 参数 配置说明 API服务 选择待导出API所在的API服务。 运行环境 选择待导出API所在的部署环境。 API
在弹窗中选择已有策略或单击“创建新策略”。 选择已有策略:单击“选择已有策略”后,选择策略。 创建新策略:请参考表2所示配置策略。 表2 配置凭据配额策略 参数 配置说明 策略名称 填写客户端配额策略的名称,根据规划自定义。建议您按照一定的命名规则填写配额策略名称,方便您快速识别和查找。 首次生效时间点 设置配额策略
一站式云端测试平台。 API测试 2021年3月 序号 功能模块 功能描述 相关文档 1 API设计 支持API整体的规划和设计,提供Mock调测和规范性检查。 API设计 2 API管理 支持API服务和API策略能力,提供API服务定义和策略管理。 支持API创建、调试和发布功能。 API管理
API全生命周期管理 API全生命周期(ROMA API)提供API设计、API实现、API管理、API消费、API分析能力,端到端从源头到资产实现企业规范化管理,帮助企业快速实现API经济,并持续构建高质量的API服务能力。 免费体验 图说ECS 立即使用 成长地图 由浅入深,带您玩转ROAM
API提供的开放API的SDK语言版本,列举了最新版本SDK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表,您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址 Reference Java
创建凭证 凭证代表用户认证标识,用户通过凭证来订阅上架的产品,订阅后方可调用对应产品下的API。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击“订阅与凭证”页签。
Finish”,完成工程导入。 在右侧Maven页签,双击“compile”进行编译。 图2 编译工程 返回“BUILD SUCCESS”,表示编译成功。 右键单击BackendSignatureApplication,选择“Run”运行服务。 图3 运行服务 “ApigatewaySignatureFilter