检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
企业API文档规范统一 当今企业随着系统内部功能逐渐增多，子系统数量成倍增长，各个系统间调用依赖愈发重要，此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器，通过规范化、标准化的API文档形成稳定资产，快速完成内部系统对外接口的统一，有效降低开发成本。
单击“创建API文件”。 在弹窗中修改“名称”，或默认系统自动生成的名称；根据下表说明，选择模板。 表1 API文件模板 模板类型 类型说明 SimpleAPI 提供简单GET请求样例。 DescriptionWithGFM 提供如何在API的描述信息中使用markdown语法，使描述信息更直观。
None 操作指导 ROMA API 如何创建API设计 02:50 创建API设计 ROMA API 如何创建API产品并上架 02:39 创建API产品 ROMA API 如何订阅API产品 02:40 订阅API产品 计算 云容器引擎 CCE 熟悉云容器引擎控制台 02:35
ode。 其他认证：向API管理者获取该API所授权应用的Key和Secret（或客户端的AppKey和AppSecret）或凭证信息。 华为IAM认证：通过云服务平台的账号凭证（账号和密码获取Token或者AK/SK）进行认证。如果使用AK/SK进行认证，还需要向API管理者获取用于调用API的SDK。
导出API服务 您可以把ROMA API上的API服务以YAML或JSON格式导出到本地，用于导入API服务或其他用途。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。
编辑”，修改流水线的执行步骤及参数。 单击“更多 > 取消关联”，取消流水线与后端的关联。 后续操作 您可以下载流水线执行成功后的jar包，将jar包部署到自己的服务器上，在控制台配置API后端服务即可。 父主题： API实现
API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API策略”。 在当前应用关联的实例中，根据实际业务选择实例。 根据下表相关任务，了解如何管理策略。 表1 管理策略 相关任务 使用场景 操作步骤 编辑策略 修改策略信息。 选择需要编辑的策略，或单击策略名称，进入策略详情。 单
环境是指API的受限使用范围，API只有在发布到环境后，才能被调用。API可以被发布到不同的自定义环境中，如开发环境、测试环境等。RELEASE是系统默认的发布环境，也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境变量，实现同一个API，在不同环境中调用不同的后端服务。
基本概念 应用 API的全生命周期管理在应用中实现，应用是一个系统资源的集合，即多个区域下，多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管
错误码 用户在调用API失败时，系统返回的错误码包含ROMA和APIG的错误码： 在ROMA实例下，系统返回的错误码请参考错误码。 在APIG实例下，系统返回的错误码请参考错误码。 父主题： 调用API
服务部署到环境上，同时间接地发布API。 已发布到环境的API，在修改配置信息后，需要重新发布才能将修改后的信息同步到环境中。 前提条件 系统已提供了默认发布环境RELEASE，如果您需要把API发布到其他环境，请提前创建环境。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA
根据下表参数说明，配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明，请参考实例配置参数说明。 参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数的最近一次更新时间。若参数从未修改过，该更新时间为空。
理、API消费和API分析五大流程。API资产从Swagger文档、后端能力、API服务和API产品在流程中轮转，并不断演进。 应用是一个系统资源的集合，API的全生命周期是在应用中实现，因此在开启API的全生命周期管理之前，您需要在“管理中心”先创建应用。 API设计 API设
API返回客户端的响应，HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头，在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头（x-apig-*，x-request-id等），包括ROMA API提供的CORS功能增加的响应头。 配置参数说明 表1 配置参数说明
的API服务，再通过HTTPMethod和PATH确定唯一的API。 在绑定域名前，您需要了解以下2个概念： 调试域名：API服务创建后，系统为服务自动分配一个内部测试用的调试域名，此域名唯一且不可更改。如果您未绑定独立域名，那么调用API时默认使用调试域名，ROMA API对调
I响应中指定您配置的响应头。 HTTP响应头管理策略 3 SLA配置 提前设计接口运行的可靠性和性能指标。 配置SLA 4 导入规则检查 系统根据默认API导入规则，检测API文件。 导入到API服务 5 后端开发 用户可以快速生成代码，并完成后端的服务能力开发。 后端开发 2021年5月
在弹窗中配置AppCode，完成后单击“确定”。 表1 配置AppCode 参数 配置说明 生成方式 选择AppCode的生成方式。 自动生成：由系统随机生成AppCode。 手动输入：自定义AppCode。 AppCode 仅手动输入方式需要填写AppCode的值。 绑定凭据配额策略 登录ROMA
什么是ROMA API ROMA API是为API提供全生命周期治理的服务，解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑，解决企业发展过程中各阶段遇到的问题，帮助企业快速实现API经济，持续构建高质量的API服务能力。
JavaScript 操作场景 使用JavaScript语言调用APP认证的API时，您需要先获取SDK，然后新建工程，最后参考API调用示例调用API。 JavaScript SDK支持Node.js、浏览器等运行环境。 关于开发环境搭建，本章节以IntelliJ IDEA 2018
调试API API创建后需要验证服务是否正常，控制台提供调试功能，您可以添加HTTP头部参数与body体参数，调试API接口。 后端路径中含有环境变量的API，不支持调试。 如果API已绑定流控策略，在调试API时，流控策略无效。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
