检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API设计配置 ROMA API提供了API设计文件规范性检查，帮助用户快速设计标准的RESTful API。您可以选择已有的规则集或者新建规则集对API设计文件进行规范性检查。
（可选）服务全局配置具体操作步骤请参考导入API设计文件。 重命名 修改API设计文件名称。 单击对应API设计文件所在行的“重命名”，即可修改名称。 删除 删除API设计文件。 单击对应API设计文件所在行的“删除”，即可删除。 API变更历史 API设计文件的变更记录。
API设计 创建API设计 API设计配置 管理API设计
单击“导入到API服务”，系统根据默认API导入规则检测API文件。 如需修复问题，单击“修复问题”根据修改建议修改问题。 图2 API导入规则检查结果 如忽略问题，可单击“继续导入”。 （可选）可视化设计API文件。
表1 产品功能 功能 说明 API可视化设计 ROMA API集成了标准的Swagger编辑器，支持编辑器编辑和表单编辑两种方式，并提供规范性检查功能，使用户可以快速、高效的在线进行API Swagger文档的设计。
基本概念 应用 API的全生命周期管理在应用中实现，应用是一个系统资源的集合，即多个区域下，多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。
中级使用者入门指导 作为中级使用者，在线设计API文件和上架API目录，需要完成以下流程： 图1 中级使用者流程图 步骤一：购买实例 在创建应用前，需要先购买实例。 步骤二：创建应用 应用是一个系统资源的集合，下面可以划分不同的服务。
产品优势 全自动化设计规范检测 从设计者体验和效率出发，提供一款便捷的API编辑器，支持标准Swagger的编辑能力和通俗易懂的表单编辑能力，并融入华为10年累积的API治理规范标准，实现全自动化检测，提升企业API设计的规范性。
应用场景 企业API文档规范统一 当今企业随着系统内部功能逐渐增多，子系统数量成倍增长，各个系统间调用依赖愈发重要，此时拥有一个API接口文档系统显得极为关键。
后端自定义认证：当不同的后端服务使用不同的认证系统时，导致您需要为不同的认证系统定制化开发API，而APIG通过自定义认证功能，将多种认证系统集成，简化API开发的复杂度。
导入API设计文件，从“API设计”中选择设计文件导入，单击“确定”。 导入Swagger文件，从本地导入文件，单击“打开”。 参考下表配置后端。 表1 后端配置参数说明 参数 参数说明 后端名称 后端的名称。 归属项目 自动读取当前应用已关联Devcloud服务中的项目。
应用是一个系统资源的集合，API的全生命周期是在应用中实现，因此在开启API的全生命周期管理之前，您需要在“管理中心”先创建应用。 API设计 API设计者主要负责API整体的规划和设计，提前Mock调测和规范检查。
实例是一个独立的资源空间，所有的操作都是在实例内进行，不同实例间的资源相互隔离；应用是一个系统资源的集合，API的全生命周期是在应用中实现。
错误码 用户在调用API失败时，系统返回的错误码包含ROMA和APIG的错误码： 在ROMA实例下，系统返回的错误码请参考错误码。 在APIG实例下，系统返回的错误码请参考错误码。 父主题： 调用API
HTTP响应头管理策略 3 SLA配置 提前设计接口运行的可靠性和性能指标。 配置SLA 4 导入规则检查 系统根据默认API导入规则，检测API文件。 导入到API服务 5 后端开发 用户可以快速生成代码，并完成后端的服务能力开发。
None 操作指导 ROMA API 如何创建API设计 02:50 创建API设计 ROMA API 如何创建API产品并上架 02:39 创建API产品 ROMA API 如何订阅API产品 02:40 订阅API产品 计算 云容器引擎 CCE 熟悉云容器引擎控制台 02:35
应用容器化改造介绍 应用容器化改造流程 步骤1：对应用进行分析 步骤2：准备应用运行环境 更多 Ping不通 应用容器化改造介绍 应用容器化改造流程 步骤1：对应用进行分析 更多 访问外网 应用容器化改造介绍 应用容器化改造流程 步骤1：对应用进行分析 步骤2：准备应用运行环境 更多 操作系统相关
在弹窗中选择要开放API所在的设计文件，单击“确定”。 系统根据默认API导入规则检测API文件。 如需修复问题，单击“修复问题”根据修改建议修改问题。 如忽略问题，单击“继续导入”。 填写服务名称，或默认系统自动生成的名称。
将A部门的业务生成设计文档。 在“API设计”页面，选择“创建API设计 > 导入Swagger文件”，导入本地API文档。如需通过其他方式创建API设计文档，请参考《用户指南》。 将设计文档封装成API服务。
导入API设计文件：从“API设计”选择API导入，生成测试用例。选择API设计文件，单击“确定”。 导入Swagger文件：从用户本地导入API，生成测试用例。选择API文件，单击“打开”。 配置用例参数。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
