检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
中级使用者入门指导 作为中级使用者，在线设计API文件和上架API目录，需要完成以下流程： 图1 中级使用者流程图 步骤一：购买实例 在创建应用前，需要先购买实例。 步骤二：创建应用 应用是一个系统资源的集合，下面可以划分不同的服务。 步骤三：创建API设计 快速在线设计标准的RESTful
企业API文档规范统一 当今企业随着系统内部功能逐渐增多，子系统数量成倍增长，各个系统间调用依赖愈发重要，此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器，通过规范化、标准化的API文档形成稳定资产，快速完成内部系统对外接口的统一，有效降低开发成本。
错误码 用户在调用API失败时，系统返回的错误码包含ROMA和APIG的错误码： 在ROMA实例下，系统返回的错误码请参考错误码。 在APIG实例下，系统返回的错误码请参考错误码。 父主题： 调用API
前端自定义认证：如果您希望使用自己的认证系统，而不是APP认证/华为IAM认证对API的访问进行认证鉴权时，您可以使用自定义认证，通过您自定义的函数进行认证鉴权。 后端自定义认证：当不同的后端服务使用不同的认证系统时，导致您需要为不同的认证系统定制化开发API，而APIG通过自定义认证功能，将多种认证系统集成，简
创建API设计 ROMA API提供了可视化的API在线设计能力，及接口规范性检查，帮助用户快速设计标准的RESTful API。在开始设计API前，您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。 本地已存在API设计
通过Explorer调试API “Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后，消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API，那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网访问并配置弹性IP，可参考实例配置参数。
API返回客户端的响应，HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头，在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头（x-apig-*，x-request-id等），包括ROMA API提供的CORS功能增加的响应头。 配置参数说明 表1 配置参数说明
单击“浏览代码”，查看代码库。代码仓库是代码托管服务存储代码的云端仓库。 单击“在线开发”，通过云端开发环境CloudIDE开发代码，请参考在线开发。 单击“克隆/下载”，克隆或下载代码。 在线开发 单击“在线开发”页签。或在“代码仓”区域，单击“在线开发”。 通过IDE左侧的资源管理器可以看到后端代码的结构，如下所示。
环境是指API的受限使用范围，API只有在发布到环境后，才能被调用。API可以被发布到不同的自定义环境中，如开发环境、测试环境等。RELEASE是系统默认的发布环境，也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境变量，实现同一个API，在不同环境中调用不同的后端服务。
基本概念 应用 API的全生命周期管理在应用中实现，应用是一个系统资源的集合，即多个区域下，多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管
查功能，使用户可以快速、高效的在线进行API Swagger文档的设计。 API快速实现 ROMA API支持通过导入API文档一键生成代码仓以及流水线，降低开发时间。 API管理 包括API的创建、发布、下线和删除的完整生命周期管理，提供便捷的在线调试能力，支持导入Swagge
根据下表参数说明，配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明，请参考实例配置参数说明。 参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数的最近一次更新时间。若参数从未修改过，该更新时间为空。
3分钟创建一个游戏类容器应用 05 开发指导 为客户端提供Java、Go、Python、C等多语言的SDK接入，业务后端无需做修改，轻松实现一套系统对接多种业务场景（如移动场景、IoT场景等）。 API认证 APP认证工作原理 APP认证-Java IAM认证 其他认证 自定义认证 对后端服务进行签名
（可选）配置默认后端的系统参数。如果后端服务需要接收系统运行时产生的参数信息，如网关内置参数、前端认证参数和后端认证参数等，可以通过设置系统参数来实现。ROMA API向后端服务发送请求时，将系统参数添加到请求的指定位置，然后将请求发送给后端服务。 在“系统参数”下，单击“添加系统参数”，添加后端服务请求的系统参数。
Connect源自华为10年+数字化转型实践。聚焦应用和数据联接，提供消息、数据、API、设备集成能力，帮助企业快速、简单的打通并管理Legacy系统与CloudNative应用，联接云上云下，消除数字鸿沟，构建业务敏捷性，驱动数字化转型。 APIG实例 API网关（API Gatewa
防篡改；从APP、API、IP等多维度设置的流控策略进行保护。 认证层 提供AK/SK、Token方式进行应用的认证，授权后才可访问；支持系统级和API级的IP黑白名单，拒绝恶意访问。 审计层 支持LTS日志分析，可为追查异常调用和恢复业务操作提供客观依据。 转发层 通过安全通道
服务部署到环境上，同时间接地发布API。 已发布到环境的API，在修改配置信息后，需要重新发布才能将修改后的信息同步到环境中。 前提条件 系统已提供了默认发布环境RELEASE，如果您需要把API发布到其他环境，请提前创建环境。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA
理、API消费和API分析五大流程。API资产从Swagger文档、后端能力、API服务和API产品在流程中轮转，并不断演进。 应用是一个系统资源的集合，API的全生命周期是在应用中实现，因此在开启API的全生命周期管理之前，您需要在“管理中心”先创建应用。 API设计 API设
I响应中指定您配置的响应头。 HTTP响应头管理策略 3 SLA配置 提前设计接口运行的可靠性和性能指标。 配置SLA 4 导入规则检查 系统根据默认API导入规则，检测API文件。 导入到API服务 5 后端开发 用户可以快速生成代码，并完成后端的服务能力开发。 后端开发 2021年5月
导入API设计文件”。 在弹窗中选择要开放API所在的设计文件，单击“确定”。 系统根据默认API导入规则检测API文件。 如需修复问题，单击“修复问题”根据修改建议修改问题。 如忽略问题，单击“继续导入”。 填写服务名称，或默认系统自动生成的名称。 在“API接口”列表中勾选要开放的API，单击“立即导入”。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
