检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
通过Explorer调试API “Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后，消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API，那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网
计费说明 ROMA API本身不收费，但需先关联资源才可使用对应功能。请参考： 专享版APIG计费说明 ROMA Connect计费说明 CodeArts计费说明
单个IP地址调用API次数上限。 不超过“API流量限制”。 与“时长”配合使用，表示单位时间内的单个IP地址请求次数上限。 如果调用方在华为云弹性云服务器，且通过弹性公网IP访问API，则不能使用此限制策略。 描述 关于控制策略的描述。 单击“确定”，完成流量控制策略的创建。 父主题：
在“配置参数”页面，找到需要配置的参数，单击“编辑”。 根据下表参数说明，配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明，请参考实例配置参数说明。 参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数
依据。 转发层 通过安全通道访问后端服务；提供负载均衡、自动熔断等能力；支持对后端服务的证书校验；提供API网关的身份认证信息、签名密钥等功能。 跨云API集成 伴随IT云化不断演进，很多企业开始把业务分散到多云，多数据中心管理。ROMA API服务提供一站式的多云协同管理，让企业数据更加安全可靠。
使用限制 无法修改ROMA API增加的系统响应头（x-apig-*，x-request-id等），包括ROMA API提供的CORS功能增加的响应头。 配置参数说明 表1 配置参数说明 参数 配置说明 Name 响应头名称。每个策略中不能添加重复名称的响应头（不区分大小写），且最多添加10条响应头。
调试API API创建后需要验证服务是否正常，控制台提供调试功能，您可以添加HTTP头部参数与body体参数，调试API接口。 后端路径中含有环境变量的API，不支持调试。 如果API已绑定流控策略，在调试API时，流控策略无效。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA
应用场景 企业API文档规范统一 当今企业随着系统内部功能逐渐增多，子系统数量成倍增长，各个系统间调用依赖愈发重要，此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器，通过规范化、标准化的API文档形成稳定资产，快速完成内部系统对外接口的统一，有效降低开发成本。
需要先创建自定义认证，自定义认证通过函数服务实现，在函数服务中编写一个函数，实现您的认证鉴权流程，或者使用函数调用您的统一鉴权服务。 说明： 后端认证依赖函数服务，此功能仅在部分区域开放。 支持跨域CORS 配置API是否支持跨域访问CORS。 CORS请求分为两类： 简单请求：头信息之中，增加一个Origin字段。
进行认证鉴权。 后端自定义认证：当不同的后端服务使用不同的认证系统时，导致您需要为不同的认证系统定制化开发API，而APIG通过自定义认证功能，将多种认证系统集成，简化API开发的复杂度。您只需要在ROMA API中创建自定义的函数认证，ROMA API通过此函数对接后端认证系统，获取后端服务的访问授权。
少个用例。 用例等级 L0：最基本的功能验证。 L1：基本功能验证，可用于继承特性的基本功能验证、迭代验收前的基本功能验证等。 L2：重要特性验证，可用于测试版本（非回归版本）中功能测试。 L3：一般功能/非重要功能验证，包括对基本/重要功能的异常测试。 L4：非常特殊输入、场景、阈值条件的用例。
购买实例 创建应用前，需要先购买实例。实例是一个独立的资源空间，所有的操作都是在实例内进行，不同实例间的资源相互隔离。ROMA API提供了ROMA Connect实例和APIG实例。 ROMA Connect实例 ROMA Connect源自华为10年+数字化转型实践。聚焦应用
助企业快速实现API经济，持续构建高质量的API服务能力。 表1 产品功能 功能 说明 API可视化设计 ROMA API集成了标准的Swagger编辑器，支持编辑器编辑和表单编辑两种方式，并提供规范性检查功能，使用户可以快速、高效的在线进行API Swagger文档的设计。 API快速实现
选择签名密钥的认证类型，可选择“APP认证”、“Basic Auth”或“Public Key”。 在应用关联实例的配置参数中开启public_key功能后，才支持选择“Public Key”类型。 Key 根据选择的密钥类型，填写不同的密钥信息。 APP认证：填写APP认证所使用密钥对的Key。
认证通过函数服务实现，在函数服务中编写一个函数，实现您的认证鉴权流程，或者使用函数调用您的统一鉴权服务。 说明： 后端认证依赖函数服务，此功能仅在部分区域开放。 表5 FunctionGraph类型定义后端服务 服务参数 参数说明 函数名 添加函数后，函数名自动生成。 函数URN
约束与限制 约束限制 功能模块 限制条件 API设计 无 API实现 应用需关联CodeArts项目 API管理（除API测试） 应用需关联APIG实例/ROMA Connect实例 API测试 应用需关联CodeArts项目 API消费 无 API分析 应用需关联APIG实例/ROMA
全量定义：包括API前端请求定义、后端服务定义和响应定义。 扩展定义：包括API前端请求定义、后端服务定义和响应定义，还包括API关联的流量控制、访问控制等策略对象的定义。 导出格式 选择导出的API服务文件格式，可选择JSON或YAML。 自定义版本 填写导出API的版本号，如果没有指定版本号，默认使用当前时间作为版本号。
使用限制 已了解前提条件。 同一API服务下，相同请求路径的所有API，只能绑定同一个跨域资源共享策略。 若API开启了“支持CORS”功能的同时，也绑定了跨域资源共享策略，则以绑定的策略为准。 若某个请求路径下有OPTIONS方法的API，则该请求路径下的所有API均不允许绑定跨域资源共享策略。
(Exception e) { e.printStackTrace(); return; } 对请求进行签名，生成okhttp3.Request对象来访问API。 okhttp3.Request signedRequest = Client.signOkhttp(request); OkHttpClient
开放给消费者使用。 步骤六：配置策略 为API绑定流控策略，对API进行流量限制。 步骤七：调试API 您可以在线调试API，确保API的功能正常。 步骤八：绑定域名 创建API服务生成的域名仅用于调试使用，您需要为API服务绑定独立的访问域名。 步骤九：创建产品 将已创建的API服务生成产品。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
