检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
参数的名称，如果参数在“Path”位置，那么参数名称需要和“路径”中的名称相同。 说明： 参数名不能是x-apig- 、x-sdk-开头，不能是x-stage，不区分大小写。 参数位置为HEADER时，参数名不能是“Authorization”和“X-Auth-Token”，不区分大小写。 参数类型
hello() { return "Hello, Devstar!"; } } 添加的代码中： @RestController表明这个类是可以处理请求的控制器类。 @GetMapping("/")表明使用hello()方法来应答由http://localhost:8080/发出的请求。
HTTP请求方法，如GET、PUT、POST等。请求方法示例： GET 添加规范URI参数（CanonicalURI），以换行符结束。 释义： 规范URI，即请求资源路径，是URI的绝对路径部分的URI编码。 格式： 根据RFC 3986标准化URI路径，移除冗余和相对路径部分，路径中每个部分必须为URI编码。如
配置环境和环境变量 环境是指API的受限使用范围，API只有在发布到环境后，才能被调用。API可以被发布到不同的自定义环境中，如开发环境、测试环境等。RELEASE是系统默认的发布环境，也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境
签名密钥 签名密钥用于后端服务验证API的身份，在API请求后端服务时，保障后端服务的安全。 签名密钥是由一对Key和Secret组成，当签名密钥创建后，ROMA API向后端服务发送此API的请求时，会增加相应的签名信息，此时需要后端服务依照同样方式进行签名，通过比对签名结果与
JavaScript 操作场景 使用JavaScript语言调用APP认证的API时，您需要先获取SDK，然后新建工程，最后参考API调用示例调用API。 JavaScript SDK支持Node.js、浏览器等运行环境。 关于开发环境搭建，本章节以IntelliJ IDEA 2018
创建API产品 API产品是从服务中挑选想要共享的API组合而成，即为将要上架的API的集合。 新建API产品 创建新的API产品。 添加API到产品 为已创建的API产品添加API。 新建API产品 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。
绑定域名 您需要为API服务绑定一个或多个独立域名，每个API服务最多可以绑定5个独立域名，同一独立域名只能绑定一个服务。绑定域名即在域名和服务之间建立映射关系，将已有的独立域名绑定到API服务上。当客户端发送请求时，根据HTTP请求中的域名定位到所属的API服务，再通过HTTP
生成产品 ROMA API支持把API服务中的API资源作为一个产品，共享给其他用户使用。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中，根据实际业务选择实例。
配置网关响应 网关响应指ROMA API未能成功处理API请求，从而产生的错误响应。ROMA API提供默认的网关响应（default），如果您需要自定义响应状态码或网关响应内容，可在API服务管理中新增网关响应，其中响应内容符合JSON格式即可。 例如，“default”网关的响应内容为：
总览 ROMA API是API全生命周期治理经验的产品，如解决从API设计、实现、管理、消费、分析全流程的管理问题。以API流程规范解决企业业务发展过程中遇到的各阶段问题，提供了规范化的产品跟工具支撑，帮助企业快速实现API经济，并持续构建高质量的API服务能力。 图1 API全生命周期
产品优势 全自动化设计规范检测 从设计者体验和效率出发，提供一款便捷的API编辑器，支持标准Swagger的编辑能力和通俗易懂的表单编辑能力，并融入华为10年累积的API治理规范标准，实现全自动化检测，提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约，自动
curl 操作场景 使用curl命令调用APP认证的API时，您需要先下载JavaScript SDK生成curl命令，然后将curl命令复制到命令行调用API。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息，具体参见认证前准备。 调用API示例
发布API 在API创建后，您需要把API发布到环境，API只有在发布到环境后，才支持被其他用户调用。 作为初级使用者，成功创建API后，您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者，在创建API服务时，您可以把服务部署到环境上，同时间接地发布API。
管理API API创建完成后，在API列表中显示新建API，同时也支持编辑、授权、下线等操作管理API。 管理API 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中，根据实际业务选择实例。
应用场景 企业API文档规范统一 当今企业随着系统内部功能逐渐增多，子系统数量成倍增长，各个系统间调用依赖愈发重要，此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器，通过规范化、标准化的API文档形成稳定资产，快速完成内部系统对外接口的统一，有效降低开发成本。
调试API API创建后需要验证服务是否正常，控制台提供调试功能，您可以添加HTTP头部参数与body体参数，调试API接口。 后端路径中含有环境变量的API，不支持调试。 如果API已绑定流控策略，在调试API时，流控策略无效。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA
管理API设计 您可以在创建的API设计文件内，创建多个API，对API进行Tag分类，或者以YAML或JSON格式导出到本地，用于导入API设计或其他用途。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏单击“API设计”。
购买实例 创建应用前，需要先购买实例。实例是一个独立的资源空间，所有的操作都是在实例内进行，不同实例间的资源相互隔离。ROMA API提供了ROMA Connect实例和APIG实例。 ROMA Connect实例 ROMA Connect源自华为10年+数字化转型实践。聚焦应用
HTTP响应头管理策略 API响应是指ROMA API返回客户端的响应，HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头，在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头（x-apig-*，x-request-id等），包括ROMA
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
