检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
中级使用者入门指导 作为中级使用者，在线设计API文件和上架API目录，需要完成以下流程： 图1 中级使用者流程图 步骤一：购买实例 在创建应用前，需要先购买实例。 步骤二：创建应用 应用是一个系统资源的集合，下面可以划分不同的服务。 步骤三：创建API设计 快速在线设计标准的RESTful
通过Explorer调试API “Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后，消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API，那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网访问并配置弹性IP，可参考实例配置参数。
创建API设计 ROMA API提供了可视化的API在线设计能力，及接口规范性检查，帮助用户快速设计标准的RESTful API。在开始设计API前，您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。 本地已存在API设计
单击“浏览代码”，查看代码库。代码仓库是代码托管服务存储代码的云端仓库。 单击“在线开发”，通过云端开发环境CloudIDE开发代码，请参考在线开发。 单击“克隆/下载”，克隆或下载代码。 在线开发 单击“在线开发”页签。或在“代码仓”区域，单击“在线开发”。 通过IDE左侧的资源管理器可以看到后端代码的结构，如下所示。
查功能，使用户可以快速、高效的在线进行API Swagger文档的设计。 API快速实现 ROMA API支持通过导入API文档一键生成代码仓以及流水线，降低开发时间。 API管理 包括API的创建、发布、下线和删除的完整生命周期管理，提供便捷的在线调试能力，支持导入Swagge
表1 SSL证书配置 参数 配置说明 证书名称 填写SSL证书的名称，根据规划自定义。建议您按照一定的命名规则填写SSL证书名称，方便您快速识别和查找。 证书内容 填写pem编码格式的SSL证书内容。 以文本方式打开待添加证书里的PEM格式证书文件（后缀名为“.pem”），将证书内容复制到“证书内容”中即可。
扩展定义：包括API前端请求定义、后端服务定义和响应定义，还包括API关联的流量控制、访问控制等策略对象的定义。 导出格式 选择导出的API服务文件格式，可选择JSON或YAML。 自定义版本 填写导出API的版本号，如果没有指定版本号，默认使用当前时间作为版本号。 父主题： API服务管理
API提供API产品目录以及订阅系统，API的管理者可将API包装成产品上架到API目录中供其他订阅者使用，订阅者可通过查看API的详细文档以及在线调试来自由的选择需要订阅的API产品。
选择已有策略：单击“选择已有策略”后，选择策略名称。 创建新策略：请参考表1所示输入信息。 表1 密钥信息 信息项 描述 密钥名称 自定义名称，用于识别不同的密钥。 类型 选择签名密钥的认证类型，可选择“APP认证”、“Basic Auth”或“Public Key”。 在应用关联实例的配
API服务提供了便捷式的API资产管理，通过规范化流程帮助企业快速实现资产变现。 丰富的API运营分析 支持详细的API调用分析和告警设置，识别系统可能存在的潜在风险，并借助离线日志分析，完成精细化的运营报表呈现，让您快速洞察API业务演进。
插件策略请参考下表配置： 表1 插件策略配置 参数 配置说明 策略名称 填写策略的名称，根据规划自定义。建议您按照一定的命名规则填写策略名称，方便您快速识别和查找。 策略类型 选择策略的类型，不同类型的策略提供不同扩展能力。 跨域资源共享：为API的跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的能力。
企业内部开放API及文档 本章节讲述企业内部如何开放API及文档。企业内部之间通过ROMA API将服务或数据变现，内部之间相互调用实现资源共享。 例如，部门A在ROMA API开放API，设计API、生成产品并上架到API目录，部门B通过API目录查看和订阅API。此时，部门A
负载通道参数说明 参数类型 参数项 说明 基本信息 通道名称 填写负载通道的名称，根据规划自定义。建议您按照一定的命名规则填写负载通道名称，方便您快速识别和查找。 端口 填写负载通道的服务器访问端口号。 分发算法 选择后端服务请求的分发算法，负载通道通过分发算法确定请求被发送到哪台服务器上。
管理API设计 您可以在创建的API设计文件内，创建多个API，对API进行Tag分类，或者以YAML或JSON格式导出到本地，用于导入API设计或其他用途。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏单击“API设计”。
配置凭据配额策略 参数 配置说明 策略名称 填写客户端配额策略的名称，根据规划自定义。建议您按照一定的命名规则填写配额策略名称，方便您快速识别和查找。 首次生效时间点 设置配额策略的生效起始时间点。例如，时长为1小时，首次生效时间点为2020/08/08 05:05:00，则表示客户端配额策略从2020/08/08
创建API服务 ROMA API提供了API服务能力，通过API服务把后端服务封装成标准RESTful格式API，并开放给其他用户使用。 目前支持三种创建服务方式： 创建API服务 创建一个简单的服务，不包含API，用户可自行创建API。 导入API设计文件 支持从“API设计”中导入设计文件，同步创建服务。
根据下表参数信息，配置前端定义。 表1 前端定义参数 信息项 描述 API名称 API名称，根据规划自定义。建议您按照一定的命名规则填写API名称，方便您快速识别和查找。 URL 前端地址由请求方法、请求协议、子域名和路径组成。 请求方法：GET、POST、DELETE、PUT、PATCH、HEAD
API设计配置 ROMA API提供了API设计文件规范性检查，帮助用户快速设计标准的RESTful API。您可以选择已有的规则集或者新建规则集对API设计文件进行规范性检查。 ROMA API也支持配置扩展字段，您按照Swagger规范性设计API的同时，也可额外自定义扩展字段。
配置网关响应 网关响应指ROMA API未能成功处理API请求，从而产生的错误响应。ROMA API提供默认的网关响应（default），如果您需要自定义响应状态码或网关响应内容，可在API服务管理中新增网关响应，其中响应内容符合JSON格式即可。 例如，“default”网关的响应内容为：
AK/SK认证 使用AK（Access Key ID）、SK（Secret Access Key）对请求进行签名。 AK：访问密钥ID。与私有访问密钥关联的唯一标识符，访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
