检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
发布API 在API创建后，您需要把API发布到环境，API只有在发布到环境后，才支持被其他用户调用。 作为初级使用者，成功创建API后，您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者，在创建API服务时，您可以把服务部署到环境上，同时间接地发布API。
功能总览 功能总览 全部 ROMA API API设计 API实现 API管理 API消费 API分析 管理中心 API SDK OBS 2.0支持ROMA API ROMA API为企业构建规范化的API全流程体系，将企业服务能力包装成标准API服务，上架市场进行售卖。
调用已发布的API API在发布到环境后，即支持被其他用户调用。根据API所使用的安全认证方式不同，调用API的操作有所差异。 获取API的请求消息 在调用API前，您需要向API管理者获取API的请求信息，包括访问域名、请求协议、请求方法、请求路径以及请求参数。 根据API使用的安全认证方式
表1 产品功能 功能 说明 API可视化设计 ROMA API集成了标准的Swagger编辑器，支持编辑器编辑和表单编辑两种方式，并提供规范性检查功能，使用户可以快速、高效的在线进行API Swagger文档的设计。
通过Explorer调试API “Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后，消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API，那么产品需要先订阅才能选择凭证调用API。
调试API API创建后需要验证服务是否正常，控制台提供调试功能，您可以添加HTTP头部参数与body体参数，调试API接口。 后端路径中含有环境变量的API，不支持调试。 如果API已绑定流控策略，在调试API时，流控策略无效。 操作步骤 登录ROMA API控制台。
说明： 后端认证依赖函数服务，此功能仅在部分区域开放。 表4 Mock类型定义后端服务 服务参数 参数说明 Mock返回结果 Mock一般用于开发调试验证。
创建API策略 支持通过策略的方式，为API提供灵活的扩展能力。 前提条件 一个API只能绑定一个相同类型的策略。 策略和API本身相互独立，只有为API绑定策略后，策略才对API生效。为API绑定策略时需指定发布环境，策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效
审核管理 2021年4月 序号 功能模块 功能描述 相关文档 1 API测试 一站式云端测试平台。 API测试 2021年3月 序号 功能模块 功能描述 相关文档 1 API设计 支持API整体的规划和设计，提供Mock调测和规范性检查。
使用限制 无法修改ROMA API增加的系统响应头（x-apig-*，x-request-id等），包括ROMA API提供的CORS功能增加的响应头。 配置参数说明 表1 配置参数说明 参数 配置说明 Name 响应头名称。
用例等级 L0：最基本的功能验证。 L1：基本功能验证，可用于继承特性的基本功能验证、迭代验收前的基本功能验证等。 L2：重要特性验证，可用于测试版本（非回归版本）中功能测试。 L3：一般功能/非重要功能验证，包括对基本/重要功能的异常测试。
应用场景 企业API文档规范统一 当今企业随着系统内部功能逐渐增多，子系统数量成倍增长，各个系统间调用依赖愈发重要，此时拥有一个API接口文档系统显得极为关键。
API列表 API列表支持查看当前实例下所有的API，包含URL、运行环境、安全认证信息。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API列表”。 在当前应用关联的实例中，根据实际业务选择实例
计费说明 ROMA API本身不收费，但需先关联资源才可使用对应功能。请参考： 专享版APIG计费说明 ROMA Connect计费说明 CodeArts计费说明
查看参数的具体功能说明，请参考实例配置参数说明。 参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数的最近一次更新时间。若参数从未修改过，该更新时间为空。
在应用关联实例的“配置参数”中开启public_key功能后， 确认Secret 填写与Secret一致的值。 单击“确定”，完成密钥的创建。 父主题： APIs管理
后端开发流程如下图所示： 图1 后端开发流程图 创建后端 后端是一种以业务功能为主的服务设计概念，每一个后端都具有自主运行的业务功能。同时，后端支持框架代码的查看、删除，以及源码包的下载功能。
约束与限制 约束限制 功能模块 限制条件 API设计 无 API实现 应用需关联CodeArts项目 API管理（除API测试） 应用需关联APIG实例/ROMA Connect实例 API测试 应用需关联CodeArts项目 API消费 无 API分析 应用需关联APIG实例/ROMA
配置环境和环境变量 环境是指API的受限使用范围，API只有在发布到环境后，才能被调用。API可以被发布到不同的自定义环境中，如开发环境、测试环境等。RELEASE是系统默认的发布环境，也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境变量
创建环境 创建环境后，在创建API服务或发布API时，可以直接将API部署到环境上。 前提条件 已创建ROMA Connect实例。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
