检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置网关响应 网关响应指ROMA API未能成功处理API请求，从而产生的错误响应。ROMA API提供默认的网关响应（default），如果您需要自定义响应状态码或网关响应内容，可在API服务管理中新增网关响应，其中响应内容符合JSON格式即可。 例如，“default”网关的响应内容为
配置环境和环境变量 环境是指API的受限使用范围，API只有在发布到环境后，才能被调用。API可以被发布到不同的自定义环境中，如开发环境、测试环境等。RELEASE是系统默认的发布环境，也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境变量
Token认证 操作场景 当您使用Token认证方式调用API时，需要获取用户Token并在调用API时将Token值设置到调用请求的“X-Auth-Token”头域中。 调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。 Token认证：通过Token认证调用请求。 AK
流量控制 流量控制支持从用户、应用和时间段等不同的维度限制对API的调用次数，保护后端服务。支持按分/按秒粒度级别的流量控制。为了提供持续稳定的服务，您可以通过创建流控策略，针对部分API进行流量控制。 每个用户最多创建30个流控策略。 API添加流控策略相当于流控策略同步绑定了API
创建后端 “后端开发”为您提供业界主流框架代码初始化能力，提供一站式创建代码仓、自动生成框架代码、创建编译构建等流水线任务能力，使后端开发无需从零开始。后端开发流程如下图所示： 图1 后端开发流程图 创建后端 后端是一种以业务功能为主的服务设计概念，每一个后端都具有自主运行的业务功能
AK/SK认证 使用AK（Access Key ID）、SK（Secret Access Key）对请求进行签名。 AK：访问密钥ID。与私有访问密钥关联的唯一标识符，访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK：与访问密钥ID结合使用的密钥，对请求进行加密签名，
产品优势 全自动化设计规范检测 从设计者体验和效率出发，提供一款便捷的API编辑器，支持标准Swagger的编辑能力和通俗易懂的表单编辑能力，并融入华为10年累积的API治理规范标准，实现全自动化检测，提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约，自动生成
签名密钥 签名密钥用于后端服务验证API的身份，在API请求后端服务时，保障后端服务的安全。 签名密钥是由一对Key和Secret组成，当签名密钥创建后，ROMA API向后端服务发送此API的请求时，会增加相应的签名信息，此时需要后端服务依照同样方式进行签名，通过比对签名结果与请求的
创建API 您可以通过创建API，把已有后端服务封装成标准的RESTFul API，并开放给其他用户使用。 创建API主要步骤：设置前端定义和安全配置和后端配置。 前提条件 已创建API服务。如果未创建API服务，请参考创建API服务。 如果后端服务需要使用VPC通道，请参考创建负载通道
发布API 在API创建后，您需要把API发布到环境，API只有在发布到环境后，才支持被其他用户调用。 作为初级使用者，成功创建API后，您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者，在创建API服务时，您可以把服务部署到环境上，同时间接地发布API。
管理API API创建完成后，在API列表中显示新建API，同时也支持编辑、授权、下线等操作管理API。 管理API 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中
调试API API创建后需要验证服务是否正常，控制台提供调试功能，您可以添加HTTP头部参数与body体参数，调试API接口。 后端路径中含有环境变量的API，不支持调试。 如果API已绑定流控策略，在调试API时，流控策略无效。 操作步骤 登录ROMA API控制台。 在控制台单击
curl 操作场景 使用curl命令调用APP认证的API时，您需要先下载JavaScript SDK生成curl命令，然后将curl命令复制到命令行调用API。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息，具体参见认证前准备。 调用
应用场景 企业API文档规范统一 当今企业随着系统内部功能逐渐增多，子系统数量成倍增长，各个系统间调用依赖愈发重要，此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器，通过规范化、标准化的API文档形成稳定资产，快速完成内部系统对外接口的统一，
中级使用者入门指导 作为中级使用者，在线设计API文件和上架API目录，需要完成以下流程： 图1 中级使用者流程图 步骤一：购买实例 在创建应用前，需要先购买实例。 步骤二：创建应用 应用是一个系统资源的集合，下面可以划分不同的服务。 步骤三：创建API设计 快速在线设计标准的RESTful
管理API设计 您可以在创建的API设计文件内，创建多个API，对API进行Tag分类，或者以YAML或JSON格式导出到本地，用于导入API设计或其他用途。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏单击
什么是ROMA API ROMA API是为API提供全生命周期治理的服务，解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑，解决企业发展过程中各阶段遇到的问题，帮助企业快速实现API经济，持续构建高质量的API服务能力
企业内部开放API及文档 本章节讲述企业内部如何开放API及文档。企业内部之间通过ROMA API将服务或数据变现，内部之间相互调用实现资源共享。 例如，部门A在ROMA API开放API，设计API、生成产品并上架到API目录，部门B通过API目录查看和订阅API。此时，部门A通过开放业务能力
创建API设计 ROMA API提供了可视化的API在线设计能力，及接口规范性检查，帮助用户快速设计标准的RESTful API。在开始设计API前，您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。 本地已存在API设计文件可单个导入
APP认证工作原理 构造规范请求。 将待发送的请求内容按照与API网关（即API管理）后台约定的规则组装，确保客户端签名、API网关后台认证时使用的请求内容一致。 使用规范请求和其他信息创建待签字符串。 使用AK/SK和待签字符串计算签名。 将生成的签名信息作为请求消息头添加到HTTP
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
