检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
产品优势 全自动化设计规范检测 从设计者体验和效率出发，提供一款便捷的API编辑器，支持标准Swagger的编辑能力和通俗易懂的表单编辑能力，并融入华为10年累积的API治理规范标准，实现全自动化检测，提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约，自动
创建API 您可以通过创建API，把已有后端服务封装成标准的RESTFul API，并开放给其他用户使用。 创建API主要步骤：设置前端定义和安全配置和后端配置。 前提条件 已创建API服务。如果未创建API服务，请参考创建API服务。 如果后端服务需要使用VPC通道，请参考创建负载通道。
总览 ROMA API是API全生命周期治理经验的产品，如解决从API设计、实现、管理、消费、分析全流程的管理问题。以API流程规范解决企业业务发展过程中遇到的各阶段问题，提供了规范化的产品跟工具支撑，帮助企业快速实现API经济，并持续构建高质量的API服务能力。 图1 API全生命周期
配置参数 实例创建完成后，可在控制台编辑实例的配置信息。 前提条件 已购买实例。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。
管理实例 实例购买完成后，在“实例管理”页面显示新创建实例的基本信息卡片，同时也支持查看实例详情、编辑实例、删除实例等操作管理实例。 前提条件 已购买实例。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域。 在左侧导航栏选择“管理中心 > 实例管理”。 根据下表相关任务，了解如何管理实例。
创建API服务 ROMA API提供了API服务能力，通过API服务把后端服务封装成标准RESTful格式API，并开放给其他用户使用。 目前支持三种创建服务方式： 创建API服务 创建一个简单的服务，不包含API，用户可自行创建API。 导入API设计文件 支持从“API设计”中导入设计文件，同步创建服务。
流量控制 流量控制支持从用户、应用和时间段等不同的维度限制对API的调用次数，保护后端服务。支持按分/按秒粒度级别的流量控制。为了提供持续稳定的服务，您可以通过创建流控策略，针对部分API进行流量控制。 每个用户最多创建30个流控策略。 API添加流控策略相当于流控策略同步绑定了
凭据管理 凭据策略用于API运行时的策略管理，支持配置APPCode、绑定凭据配额策略和绑定访问控制策略，且只有管理员（IAM用户拥有“Tenant Administrator”权限）能设置。 凭据策略分三种类型：集成凭据、订阅凭据和客户凭据（集成凭据由ROMA实例下的集成应用同
APP认证工作原理 构造规范请求。 将待发送的请求内容按照与API网关（即API管理）后台约定的规则组装，确保客户端签名、API网关后台认证时使用的请求内容一致。 使用规范请求和其他信息创建待签字符串。 使用AK/SK和待签字符串计算签名。 将生成的签名信息作为请求消息头添加到H
跨域资源共享策略 出于安全性考虑，浏览器会限制从页面脚本内发起的跨域请求，此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求，从而实现跨域访问。更多跨域访问的说明请参考开启跨域共享。 跨域资源共享策略为跨域访问提供指定预检请求头和响应
访问控制 访问控制策略是ROMA API提供的API安全防护组件之一，主要用来控制访问API的IP地址和账户，您可以创建访问控制策略，允许/禁止某个IP地址或账号访问绑定策略的API。 每个用户最多可以创建100个访问控制策略。 API添加访问控制策略相当于访问控制策略同步绑定了
创建API策略 支持通过策略的方式，为API提供灵活的扩展能力。 前提条件 一个API只能绑定一个相同类型的策略。 策略和API本身相互独立，只有为API绑定策略后，策略才对API生效。为API绑定策略时需指定发布环境，策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效，不需要重新发布API。
创建自定义认证 自定义认证包含两种认证：前端自定义认证和后端自定义认证。 前端自定义认证：如果您希望使用自己的认证系统，而不是APP认证/华为IAM认证对API的访问进行认证鉴权时，您可以使用自定义认证，通过您自定义的函数进行认证鉴权。 后端自定义认证：当不同的后端服务使用不同的
API管理 API服务管理 APIs管理 API列表 策略管理 自定义认证 SSL证书管理 API测试 凭据管理
上架目录 将API产品上架到API目录，供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 选择需要上架的API产品，单击产品名称。 在“版本列表”中，选择上架版本，单击“上架”。
配置网关响应 网关响应指ROMA API未能成功处理API请求，从而产生的错误响应。ROMA API提供默认的网关响应（default），如果您需要自定义响应状态码或网关响应内容，可在API服务管理中新增网关响应，其中响应内容符合JSON格式即可。 例如，“default”网关的响应内容为：
通过Explorer调试API “Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后，消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API，那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网
签名密钥 签名密钥用于后端服务验证API的身份，在API请求后端服务时，保障后端服务的安全。 签名密钥是由一对Key和Secret组成，当签名密钥创建后，ROMA API向后端服务发送此API的请求时，会增加相应的签名信息，此时需要后端服务依照同样方式进行签名，通过比对签名结果与
API测试 通过导入API生成测试用例，快速实现API测试覆盖。 使用场景 API上线后，测试API连通性，以及通过定时测试任务来保障API稳定且长效运行。 前提条件 对应实例已绑定弹性IP地址。 已开通测试计划。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA
绑定域名 您需要为API服务绑定一个或多个独立域名，每个API服务最多可以绑定5个独立域名，同一独立域名只能绑定一个服务。绑定域名即在域名和服务之间建立映射关系，将已有的独立域名绑定到API服务上。当客户端发送请求时，根据HTTP请求中的域名定位到所属的API服务，再通过HTTP
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
