检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在左侧导航栏单击“API设计”。 在页面右上角单击“API设计配置”。 在“API设计配置”页面，单击“扩展字段配置”。 单击“添加扩展字段”，定义扩展字段。 表1 定义扩展字段 信息项 描述 Key 填写Key值。 显示名 填写扩展字段名称。 显示样式 填写扩展字段的值，支持文本框、单选框、复选框和下拉列表的形式。
创建API设计 ROMA API提供了可视化的API在线设计能力，及接口规范性检查，帮助用户快速设计标准的RESTful API。在开始设计API前，您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。 本地已存在API设计文件可
在左侧导航栏单击“API设计”。 根据下表相关任务，了解如何管理API设计文件。 表1 管理API设计 相关任务 使用场景 操作步骤 导入到API服务 从API设计文件中挑选部分API接口生成API服务，开放给其他用户使用。 单击对应API设计文件所在行的“导入到API服务”。或单击“编辑器
API设计 创建API设计 API设计配置 管理API设计
项目，单击“保存”。 单击“创建后端”，选择导入文件类型。 导入API设计文件，从“API设计”中选择设计文件导入，单击“确定”。 导入Swagger文件，从本地导入文件，单击“打开”。 参考下表配置后端。 表1 后端配置参数说明 参数 参数说明 后端名称 后端的名称。 归属项目
编辑”。 根据下表参数说明，配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明，请参考实例配置参数说明。 参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数的最近一次更新时间。若参数从未修改过，该更新时间为空。
API是为API提供全生命周期治理的服务，解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑，解决企业发展过程中各阶段遇到的问题，帮助企业快速实现API经济，持续构建高质量的API服务能力。 表1 产品功能 功能 说明 API可视化设计 ROMA API
创建API服务 创建一个简单的服务，不包含API，用户可自行创建API。 导入API设计文件 支持从“API设计”中导入设计文件，同步创建服务。 导入Swagger文件 从本地导入已有的API设计文件，同步创建服务。 创建API服务 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA
API服务，单击“确定”。 导入API设计文件：从“API设计”选择API导入，生成测试用例。选择API设计文件，单击“确定”。 导入Swagger文件：从用户本地导入API，生成测试用例。选择API文件，单击“打开”。 配置用例参数。 表1 用例参数 参数 配置说明 用例名称 用例的名称，根据规划自定义。
及响应内容。 响应内容的错误信息以及其他信息，可通过变量的方式获取，支持的变量见表2。 网关错误响应类型说明 ROMA API提供的错误响应类型见表1，其中响应状态码可以按实际需要做自定义修改。 表1 ROMA API的错误响应类型 错误响应类型 默认的响应状态码 错误说明 详细说明
单击“创建”。 应用创建完成后，您可以在页面左上角“ROMA API”下切换待操作的应用。 首次创建应用后，页面自动跳转到“API设计”，可根据业务需求自行创建设计文件。 应用授权 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心
应用 API的全生命周期管理在应用中实现，应用是一个系统资源的集合，即多个区域下，多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管理提供了API
OBS 2.0支持API设计 主要介绍API设计者如何设计API文件。在API设计和变更阶段指导设计者遵从API格式规范，提升企业API的交付质量。 支持区域：华北-北京一、华北-北京四、华东-上海一、华东-上海二、华南-广州、乌兰察布二零二 创建API设计 管理规则集 OBS 2
开放API A部门将自己的业务变现。 将A部门的业务生成设计文档。 在“API设计”页面，选择“创建API设计 > 导入Swagger文件”，导入本地API文档。如需通过其他方式创建API设计文档，请参考《用户指南》。 将设计文档封装成API服务。 在“编辑器”页面，单击“导入到API服务”，规则检查通过后，继续导入。
实现，因此在开启API的全生命周期管理之前，您需要在“管理中心”先创建应用。 API设计 API设计者主要负责API整体的规划和设计，提前Mock调测和规范检查。 API实现 API开发者负责后端的业务开发、版本测试、验证、版本发布等。 API管理 API管理主要包含API服务、
产品优势 全自动化设计规范检测 从设计者体验和效率出发，提供一款便捷的API编辑器，支持标准Swagger的编辑能力和通俗易懂的表单编辑能力，并融入华为10年累积的API治理规范标准，实现全自动化检测，提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约，自动
“日志组”和“日志流”设置完成后，单击“确定”。 查看日志分析可单击“日志字段说明”，根据日志字段说明分析日志。 访问日志的字段采用空格作为分隔符，按照顺序，每个字段的含义如下： 表1 日志字段说明 序号 字段 说明 1 remote_addr 客户端地址 2 request_id
API”下切换已创建的应用。 步骤三：创建API设计 在左侧导航栏单击“API设计”。 单击“创建API文件”，选择“导入Swagger文件”导入本地API设计文件。 编辑API，并单击“规范性检查”，按照“Compliance”提示修改内容。 图4 创建API设计 单击“保存”。 步骤四：后端开发（可选）
API提供的开放API的SDK语言版本，列举了最新版本SDK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表，您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址 Reference Java
管理自定义认证 API自定义认证创建完成后，在自定义认证列表中显示新创建认证信息，同时也支持编辑、删除、更新等操作管理自定义认证。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API策略”。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
