检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
什么是ROMA API 产品优势 应用场景 约束与限制 03 入门 如何实现一个完整的API全生命周期管理，您可以从初级使用者或中级使用者快速上手。 快速入门 初级使用者入门 中级使用者入门 05 实践 弹性云服务器（Elastic Cloud Server）是一种可随时自动获取、计算能力可弹性伸缩的云服务器。
供规范性检查功能，使用户可以快速、高效的在线进行API Swagger文档的设计。 API快速实现 ROMA API支持通过导入API文档一键生成代码仓以及流水线，降低开发时间。 API管理 包括API的创建、发布、下线和删除的完整生命周期管理，提供便捷的在线调试能力，支持导入S
创建API设计 ROMA API提供了可视化的API在线设计能力，及接口规范性检查，帮助用户快速设计标准的RESTful API。在开始设计API前，您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。 本地已存在API设计
实现API的内部市场 ROMA API提供API产品目录以及订阅系统，API的管理者可将API包装成产品上架到API目录中供其他订阅者使用，订阅者可通过查看API的详细文档以及在线调试来自由的选择需要订阅的API产品。
击“启用”。 如需创建规则集，请参考创建规则集。 在弹窗中单击“确定”。 在已启用的规则集显示“当前使用”，规则集启用成功。 如需取消已启用的规则集，可启用另一个规则集，将当前使用规则集覆盖。 如需查看已启用规则，可单击规则集名称。 （可选）查看规则集详情，包含已启用规则和未启用规则，可单击“管理”或“查看”。
概述 使用APP认证调用API APP认证需要通过SDK访问。 使用IAM认证调用API 支持Token认证和AK/SK认证两种。 Token认证：通过Token认证调用请求。Token认证无需使用SDK签名，优先使用Token认证。 AK/SK认证：通过AK（Access Key
分发算法确定请求被发送到哪台服务器上。 健康检查配置 协议 选择健康检查所使用的协议，可选择“TCP”、“HTTP”和“HTTPS”。 双向认证 仅当“协议”选择“HTTPS”时需要配置。 是否选择“使用backend_client_certificate配置的证书做客户端认证”
供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击产品右侧的“订阅”。 在弹框中选择版本号和凭证，填写申请描述。 您可以使用已有的凭证或者新建凭证，新建凭证具体操作请参考创建凭证。
多个URI之间使用英文逗号隔开。 对于未携带身份凭证的请求，可以把参数值设置为“*”，表示允许来自所有域的访问请求。 allowed methods Access-Control-Allow-Methods响应头，指定允许使用的HTTP请求方法，多个请求方法之间使用英文逗号隔开。
自定义认证包含两种认证：前端自定义认证和后端自定义认证。 前端自定义认证：如果您希望使用自己的认证系统，而不是APP认证/华为IAM认证对API的访问进行认证鉴权时，您可以使用自定义认证，通过您自定义的函数进行认证鉴权。 后端自定义认证：当不同的后端服务使用不同的认证系统时，导致您需要为不同的认证系统定制化开发
已在控制台创建签名密钥，并绑定API，具体请参见创建并使用签名密钥。 下载SDK的最新版本。 获取并安装Python安装包（可使用2.7或3.X），如果未安装，请至Python官方下载页面下载。 获取并安装IntelliJ IDEA，如果未安装，请至IntelliJ IDEA官方网站下载。 已在IntelliJ
在左侧导航栏单击“API设计”。 根据下表相关任务，了解如何管理API设计文件。 表1 管理API设计 相关任务 使用场景 操作步骤 导入到API服务 从API设计文件中挑选部分API接口生成API服务，开放给其他用户使用。 单击对应API设计文件所在行的“导入到API服务”。或单击“编辑器”/“表单”页面中的“导入到API服务”。
API测试 通过导入API生成测试用例，快速实现API测试覆盖。 使用场景 API上线后，测试API连通性，以及通过定时测试任务来保障API稳定且长效运行。 前提条件 对应实例已绑定弹性IP地址。 已开通测试计划。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA
运行服务器，验证代码正确性。下面示例使用JavaScript SDK中的html签名工具生成签名。 填入如图所示字段后，单击“Send request”，复制生成的curl命令，并在命令行中执行，服务器返回“Hello World!”。 如果使用错误的Key和Secret访问，服务器返回401认证不通过。
C# 操作场景 使用C#语言进行后端服务签名时，您需要先获取SDK，然后打开工程，最后参考校验后端签名示例校验签名是否一致。 准备环境 准备待用的签名密钥的Key和Secret。 已在控制台创建签名密钥，并绑定API，具体请参见创建并使用签名密钥。 下载SDK的最新版本。 获取并安装Visual
上架目录 将API产品上架到API目录，供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 选择需要上架的API产品，单击产品名称。 在“版本列表”中，选择上架版本，单击“上架”。
接口定义多个不同Path。 例如，请求路径为/test/AA，使用前缀匹配时，通过/test/AA/CC可以访问，但是通过/test/AACC无法访问。 说明： 使用前缀匹配时，匹配剩余的路径将透传到后端。 例如，使用前缀匹配，前端请求路径定义为/test/，后端请求路径定义为/
根据下表相关任务，了解如何管理API。 表1 管理API 相关任务 使用场景 操作步骤 编辑API 修改API信息。 选择需要编辑的API。 单击“编辑”，修改API信息，具体操作请参考创建API。 授权API 仅使用APP认证方式的API，才需要授权，发布API后，通过指定授权给某些应用，让指定应用能够调用API。
计费说明 ROMA API本身不收费，但需先关联资源才可使用对应功能。请参考： 专享版APIG计费说明 ROMA Connect计费说明 CodeArts计费说明
ROMA API允许使用服务分配的子域名或服务绑定的域名调用API，无需另外配置。 使用IP调用API ROMA API的实例配置参数“app_route”已设置为“on”，允许通过IP访问API。 允许使用IP地址调用API，无需另外配置。 配置认证参数。 API认证方式 API请求参数配置
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
