检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
企业API文档规范统一 当今企业随着系统内部功能逐渐增多，子系统数量成倍增长，各个系统间调用依赖愈发重要，此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器，通过规范化、标准化的API文档形成稳定资产，快速完成内部系统对外接口的统一，有效降低开发成本。
错误码 用户在调用API失败时，系统返回的错误码包含ROMA和APIG的错误码： 在ROMA实例下，系统返回的错误码请参考错误码。 在APIG实例下，系统返回的错误码请参考错误码。 父主题： 调用API
前端自定义认证：如果您希望使用自己的认证系统，而不是APP认证/华为IAM认证对API的访问进行认证鉴权时，您可以使用自定义认证，通过您自定义的函数进行认证鉴权。 后端自定义认证：当不同的后端服务使用不同的认证系统时，导致您需要为不同的认证系统定制化开发API，而APIG通过自定义认证功能，将多种认证系统集成，简
后端开发流程图 创建后端 后端是一种以业务功能为主的服务设计概念，每一个后端都具有自主运行的业务功能。同时，后端支持框架代码的查看、删除，以及源码包的下载功能。 在线开发 后端创建完成后，您可以使用“在线开发”开发代码，通过CodeArts IDE Online修改代码包中的DemoApplication
作为中级使用者，在线设计API文件和上架API目录，需要完成以下流程： 图1 中级使用者流程图 步骤一：购买实例 在创建应用前，需要先购买实例。 步骤二：创建应用 应用是一个系统资源的集合，下面可以划分不同的服务。 步骤三：创建API设计 快速在线设计标准的RESTful API。 步骤四：后端开发（可选） 支持一
基本概念 应用 API的全生命周期管理在应用中实现，应用是一个系统资源的集合，即多个区域下，多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管
API返回客户端的响应，HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头，在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头（x-apig-*，x-request-id等），包括ROMA API提供的CORS功能增加的响应头。 配置参数说明 表1 配置参数说明
环境是指API的受限使用范围，API只有在发布到环境后，才能被调用。API可以被发布到不同的自定义环境中，如开发环境、测试环境等。RELEASE是系统默认的发布环境，也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境变量，实现同一个API，在不同环境中调用不同的后端服务。
根据下表参数说明，配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明，请参考实例配置参数说明。 参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数的最近一次更新时间。若参数从未修改过，该更新时间为空。
随着企业规模变大，API资产的积累急剧上升，资产管理成为核心痛点，ROMA API服务提供了便捷式的API资产管理，通过规范化流程帮助企业快速实现资产变现。 丰富的API运营分析 支持详细的API调用分析和告警设置，识别系统可能存在的潜在风险，并借助离线日志分析，完成精细化的运营报表呈现，让您快速洞察API业务演进。
（可选）配置默认后端的系统参数。如果后端服务需要接收系统运行时产生的参数信息，如网关内置参数、前端认证参数和后端认证参数等，可以通过设置系统参数来实现。ROMA API向后端服务发送请求时，将系统参数添加到请求的指定位置，然后将请求发送给后端服务。 在“系统参数”下，单击“添加系统参数”，添加后端服务请求的系统参数。
Connect源自华为10年+数字化转型实践。聚焦应用和数据联接，提供消息、数据、API、设备集成能力，帮助企业快速、简单的打通并管理Legacy系统与CloudNative应用，联接云上云下，消除数字鸿沟，构建业务敏捷性，驱动数字化转型。 APIG实例 API网关（API Gatewa
服务部署到环境上，同时间接地发布API。 已发布到环境的API，在修改配置信息后，需要重新发布才能将修改后的信息同步到环境中。 前提条件 系统已提供了默认发布环境RELEASE，如果您需要把API发布到其他环境，请提前创建环境。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA
在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏单击“API设计”。 单击“创建API文件”。 在弹窗中修改“名称”，或默认系统自动生成的名称；根据下表说明，选择模板。 表1 API文件模板 模板类型 类型说明 SimpleAPI 提供简单GET请求样例。 DescriptionWithGFM
理、API消费和API分析五大流程。API资产从Swagger文档、后端能力、API服务和API产品在流程中轮转，并不断演进。 应用是一个系统资源的集合，API的全生命周期是在应用中实现，因此在开启API的全生命周期管理之前，您需要在“管理中心”先创建应用。 API设计 API设
填写客户端配额策略的名称，根据规划自定义。建议您按照一定的命名规则填写配额策略名称，方便您快速识别和查找。 首次生效时间点 设置配额策略的生效起始时间点。例如，时长为1小时，首次生效时间点为2020/08/08 05:05:00，则表示客户端配额策略从2020/08/08 05:05:00开始
I响应中指定您配置的响应头。 HTTP响应头管理策略 3 SLA配置 提前设计接口运行的可靠性和性能指标。 配置SLA 4 导入规则检查 系统根据默认API导入规则，检测API文件。 导入到API服务 5 后端开发 用户可以快速生成代码，并完成后端的服务能力开发。 后端开发 2021年5月
导入API设计文件”。 在弹窗中选择要开放API所在的设计文件，单击“确定”。 系统根据默认API导入规则检测API文件。 如需修复问题，单击“修复问题”根据修改建议修改问题。 如忽略问题，单击“继续导入”。 填写服务名称，或默认系统自动生成的名称。 在“API接口”列表中勾选要开放的API，单击“立即导入”。
的API服务，再通过HTTPMethod和PATH确定唯一的API。 在绑定域名前，您需要了解以下2个概念： 调试域名：API服务创建后，系统为服务自动分配一个内部测试用的调试域名，此域名唯一且不可更改。如果您未绑定独立域名，那么调用API时默认使用调试域名，ROMA API对调
2.0支持管理中心 主要介绍实例管理和应用管理。实例是一个独立的资源空间，所有的操作都是在实例内进行，不同实例间的资源相互隔离；应用是一个系统资源的集合，API的全生命周期是在应用中实现。 支持区域：华北-北京一、华北-北京四、华东-上海一、华东-上海二、华南-广州、乌兰察布二零二
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
