检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 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。 前提条件 应用关联的实例已开启公网访问并配置弹性IP，可参考实例配置参数。
创建API 您可以通过创建API，把已有后端服务封装成标准的RESTFul API，并开放给其他用户使用。 创建API主要步骤：设置前端定义和安全配置和后端配置。 前提条件 已创建API服务。如果未创建API服务，请参考创建API服务。 如果后端服务需要使用VPC通道，请参考创建负载通道。
创建API设计 ROMA API提供了可视化的API在线设计能力，及接口规范性检查，帮助用户快速设计标准的RESTful API。在开始设计API前，您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。 本地已存在API设计
单击“浏览代码”，查看代码库。代码仓库是代码托管服务存储代码的云端仓库。 单击“在线开发”，通过云端开发环境CloudIDE开发代码，请参考在线开发。 单击“克隆/下载”，克隆或下载代码。 在线开发 单击“在线开发”页签。或在“代码仓”区域，单击“在线开发”。 通过IDE左侧的资源管理器可以看到后端代码的结构，如下所示。
查功能，使用户可以快速、高效的在线进行API Swagger文档的设计。 API快速实现 ROMA API支持通过导入API文档一键生成代码仓以及流水线，降低开发时间。 API管理 包括API的创建、发布、下线和删除的完整生命周期管理，提供便捷的在线调试能力，支持导入Swagge
中级使用者入门指导 作为中级使用者，在线设计API文件和上架API目录，需要完成以下流程： 图1 中级使用者流程图 步骤一：购买实例 在创建应用前，需要先购买实例。 步骤二：创建应用 应用是一个系统资源的集合，下面可以划分不同的服务。 步骤三：创建API设计 快速在线设计标准的RESTful
API提供API产品目录以及订阅系统，API的管理者可将API包装成产品上架到API目录中供其他订阅者使用，订阅者可通过查看API的详细文档以及在线调试来自由的选择需要订阅的API产品。
Python 操作场景 使用Python语言进行后端服务签名时，您需要先获取SDK，然后导入工程，最后参考校验后端签名示例校验签名是否一致。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 准备环境 准备待用的签名密钥的Key和Secret。 已在控制台创建签
企业内部开放API及文档 本章节讲述企业内部如何开放API及文档。企业内部之间通过ROMA API将服务或数据变现，内部之间相互调用实现资源共享。 例如，部门A在ROMA API开放API，设计API、生成产品并上架到API目录，部门B通过API目录查看和订阅API。此时，部门A
管理API产品 API产品创建完成后，在产品列表中显示新创建API产品信息，同时也支持下架、下线等操作管理API。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 根据下表相关任务，了解如何管理API产品。
HexEncode(HMAC(APP secret, string to sign)) 其中HMAC指密钥相关的哈希运算，HexEncode指转十六进制。伪代码中参数说明如表1所示。 表1 参数说明 参数名称 参数解释 APP secret 签名密钥 string to sign 创建的待签字符串
Token认证 操作场景 当您使用Token认证方式调用API时，需要获取用户Token并在调用API时将Token值设置到调用请求的“X-Auth-Token”头域中。 调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。 Token认证：通过Token认证调用请求。 AK/SK认证：通过AK（Access
配置环境和环境变量 环境是指API的受限使用范围，API只有在发布到环境后，才能被调用。API可以被发布到不同的自定义环境中，如开发环境、测试环境等。RELEASE是系统默认的发布环境，也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境
Java 操作场景 使用Java语言进行后端服务签名时，您需要先获取SDK，然后导入工程，最后参考校验后端签名示例校验签名是否一致。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 前提条件 准备待用的签名密钥的Key和Secret。 已在控制台创建签名密钥，
访问控制 访问控制策略是ROMA API提供的API安全防护组件之一，主要用来控制访问API的IP地址和账户，您可以创建访问控制策略，允许/禁止某个IP地址或账号访问绑定策略的API。 每个用户最多可以创建100个访问控制策略。 API添加访问控制策略相当于访问控制策略同步绑定了
AK/SK认证 使用AK（Access Key ID）、SK（Secret Access Key）对请求进行签名。 AK：访问密钥ID。与私有访问密钥关联的唯一标识符，访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。
流量控制 流量控制支持从用户、应用和时间段等不同的维度限制对API的调用次数，保护后端服务。支持按分/按秒粒度级别的流量控制。为了提供持续稳定的服务，您可以通过创建流控策略，针对部分API进行流量控制。 每个用户最多创建30个流控策略。 API添加流控策略相当于流控策略同步绑定了
创建应用 开始使用ROMA API前，您需要先创建应用，然后在应用中创建和管理您的API资源。 账号用户可管理其下所有IAM用户所创建的应用和资源，IAM用户只能管理自己创建的应用和资源，默认无法查看其他IAM用户创建的应用和资源。您可以通过应用授权的方式，把应用下的资源共享给同一账号下的其他IAM用户来查看和使用。
创建凭证 凭证代表用户认证标识，用户通过凭证来订阅上架的产品，订阅后方可调用对应产品下的API。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击“订阅与凭证”页签。
签名密钥 签名密钥用于后端服务验证API的身份，在API请求后端服务时，保障后端服务的安全。 签名密钥是由一对Key和Secret组成，当签名密钥创建后，ROMA API向后端服务发送此API的请求时，会增加相应的签名信息，此时需要后端服务依照同样方式进行签名，通过比对签名结果与
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
