检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API设计配置 ROMA API提供了API设计文件规范性检查,帮助用户快速设计标准的RESTful API。您可以选择已有的规则集或者新建规则集对API设计文件进行规范性检查。 ROMA API也支持配置扩展字段,您按照Swagger规范性设计API的同时,也可额外自定义扩展字段。
创建API设计 ROMA API提供了可视化的API在线设计能力,及接口规范性检查,帮助用户快速设计标准的RESTful API。在开始设计API前,您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。 本地已存在API设计文件可
(可选)服务全局配置具体操作步骤请参考导入API设计文件。 重命名 修改API设计文件名称。 单击对应API设计文件所在行的“重命名”,即可修改名称。 删除 删除API设计文件。 单击对应API设计文件所在行的“删除”,即可删除。 API变更历史 API设计文件的变更记录。支持查看变更前后的内容和还原变更内容。
API设计 创建API设计 API设计配置 管理API设计
OBS 2.0支持API设计 主要介绍API设计者如何设计API文件。在API设计和变更阶段指导设计者遵从API格式规范,提升企业API的交付质量。 支持区域:华北-北京一、华北-北京四、华东-上海一、华东-上海二、华南-广州、乌兰察布二零二 创建API设计 管理规则集 OBS 2
创建API服务 创建一个简单的服务,不包含API,用户可自行创建API。 导入API设计文件 支持从“API设计”中导入设计文件,同步创建服务。 导入Swagger文件 从本地导入已有的API设计文件,同步创建服务。 创建API服务 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
API是为API提供全生命周期治理的服务,解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑,解决企业发展过程中各阶段遇到的问题,帮助企业快速实现API经济,持续构建高质量的API服务能力。 表1 产品功能 功能 说明 API可视化设计 ROMA API
API”下切换已创建的应用。 步骤三:创建API设计 在左侧导航栏单击“API设计”。 单击“创建API文件”,选择“导入Swagger文件”导入本地API设计文件。 编辑API,并单击“规范性检查”,按照“Compliance”提示修改内容。 图4 创建API设计 单击“保存”。 步骤四:后端开发(可选)
CodeArts计费说明 快速购买 购买实例 购买CodeArts 04 使用 从设计、实现、管理、消费、分析提供完整的API全生命周期管理解决方案,帮助您轻松构建、管理和部署任意规模的API。 API设计 创建API设计 管理规则集 API实现 创建后端 API管理 创建API服务 绑定域名
单击“关联资源”。 在“项目资源”区域,选择您的DevCloud项目,单击“保存”。 单击“创建后端”,选择导入文件类型。 导入API设计文件,从“API设计”中选择设计文件导入,单击“确定”。 导入Swagger文件,从本地导入文件,单击“打开”。 参考下表配置后端。 表1 后端配置参数说明
导入API服务:从“API服务”中选择API导入,生成测试用例。选择API服务,单击“确定”。 导入API设计文件:从“API设计”选择API导入,生成测试用例。选择API设计文件,单击“确定”。 导入Swagger文件:从用户本地导入API,生成测试用例。选择API文件,单击“打开”。
产品优势 全自动化设计规范检测 从设计者体验和效率出发,提供一款便捷的API编辑器,支持标准Swagger的编辑能力和通俗易懂的表单编辑能力,并融入华为10年累积的API治理规范标准,实现全自动化检测,提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约,自动
实现,因此在开启API的全生命周期管理之前,您需要在“管理中心”先创建应用。 API设计 API设计者主要负责API整体的规划和设计,提前Mock调测和规范检查。 API实现 API开发者负责后端的业务开发、版本测试、验证、版本发布等。 API管理 API管理主要包含API服务、
应用 API的全生命周期管理在应用中实现,应用是一个系统资源的集合,即多个区域下,多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管理提供了API
None 操作指导 ROMA API 如何创建API设计 02:50 创建API设计 ROMA API 如何创建API产品并上架 02:39 创建API产品 ROMA API 如何订阅API产品 02:40 订阅API产品 计算 云容器引擎 CCE 熟悉云容器引擎控制台 02:35
开放API A部门将自己的业务变现。 将A部门的业务生成设计文档。 在“API设计”页面,选择“创建API设计 > 导入Swagger文件”,导入本地API文档。如需通过其他方式创建API设计文档,请参考《用户指南》。 将设计文档封装成API服务。 在“编辑器”页面,单击“导入到API服务”,规则检查通过后,继续导入。
API测试 一站式云端测试平台。 API测试 2021年3月 序号 功能模块 功能描述 相关文档 1 API设计 支持API整体的规划和设计,提供Mock调测和规范性检查。 API设计 2 API管理 支持API服务和API策略能力,提供API服务定义和策略管理。 支持API创建、调试和发布功能。
单击“创建”。 应用创建完成后,您可以在页面左上角“ROMA API”下切换待操作的应用。 首次创建应用后,页面自动跳转到“API设计”,可根据业务需求自行创建设计文件。 应用授权 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心
约束与限制 约束限制 功能模块 限制条件 API设计 无 API实现 应用需关联CodeArts项目 API管理(除API测试) 应用需关联APIG实例/ROMA Connect实例 API测试 应用需关联CodeArts项目 API消费 无 API分析 应用需关联APIG实例/ROMA