检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
<script src="js/hmac-sha256.js"></script> <script src="js/moment.min.js"></script> <script src="js/moment-timezone-with-data.min.js"></script
应用场景 企业API文档规范统一 当今企业随着系统内部功能逐渐增多，子系统数量成倍增长，各个系统间调用依赖愈发重要，此时拥有一个API接口文档系统显得极为关键。
错误码 用户在调用API失败时，系统返回的错误码包含ROMA和APIG的错误码： 在ROMA实例下，系统返回的错误码请参考错误码。 在APIG实例下，系统返回的错误码请参考错误码。 父主题： 调用API
后端自定义认证：当不同的后端服务使用不同的认证系统时，导致您需要为不同的认证系统定制化开发API，而APIG通过自定义认证功能，将多种认证系统集成，简化API开发的复杂度。
应用容器化改造介绍 应用容器化改造流程 步骤1：对应用进行分析 步骤2：准备应用运行环境 更多 Ping不通 应用容器化改造介绍 应用容器化改造流程 步骤1：对应用进行分析 更多 访问外网 应用容器化改造介绍 应用容器化改造流程 步骤1：对应用进行分析 步骤2：准备应用运行环境 更多 操作系统相关
步骤二：创建应用 应用是一个系统资源的集合，下面可以划分不同的服务。 步骤三：创建API设计 快速在线设计标准的RESTful API。 步骤四：后端开发（可选） 支持一站式创建代码仓、自动生成框架代码、创建编译构建等流水线任务能力。
使用限制 无法修改ROMA API增加的系统响应头（x-apig-*，x-request-id等），包括ROMA API提供的CORS功能增加的响应头。 配置参数说明 表1 配置参数说明 参数 配置说明 Name 响应头名称。
RELEASE是系统默认的发布环境，也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境变量，实现同一个API，在不同环境中调用不同的后端服务。 当创建API时定义了变量标识，则需要在环境中添加变量。
基本概念 应用 API的全生命周期管理在应用中实现，应用是一个系统资源的集合，即多个区域下，多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。
参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数的最近一次更新时间。若参数从未修改过，该更新时间为空。 表2 实例配置参数说明 参数名 参数说明 ratelimit_api_limits API全局默认流控值。
在“系统参数”下，单击“添加系统参数”，添加后端服务请求的系统参数。 表8 系统参数配置 数 配置说明 系统参数类型 选择系统参数的类型。 网关内置参数：ROMA API支持配置的参数。 前端认证参数：前端自定义认证返回结果中的参数。
简单、快速、低成本、低风险的实现内部系统集成、成熟业务能力开放及业务能力变现。
丰富的API运营分析 支持详细的API调用分析和告警设置，识别系统可能存在的潜在风险，并借助离线日志分析，完成精细化的运营报表呈现，让您快速洞察API业务演进。
前提条件 系统已提供了默认发布环境RELEASE，如果您需要把API发布到其他环境，请提前创建环境。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。
单击“导入到API服务”，系统根据默认API导入规则检测API文件。 如需修复问题，单击“修复问题”根据修改建议修改问题。 图2 API导入规则检查结果 如忽略问题，可单击“继续导入”。 （可选）可视化设计API文件。
应用是一个系统资源的集合，API的全生命周期是在应用中实现，因此在开启API的全生命周期管理之前，您需要在“管理中心”先创建应用。 API设计 API设计者主要负责API整体的规划和设计，提前Mock调测和规范检查。
配置SLA 4 导入规则检查 系统根据默认API导入规则，检测API文件。 导入到API服务 5 后端开发 用户可以快速生成代码，并完成后端的服务能力开发。 后端开发 2021年5月 序号 功能名称 功能描述 相关文档 1 全局APP 应用支持多区域、多资源管理。
系统根据默认API导入规则检测API文件。 如需修复问题，单击“修复问题”根据修改建议修改问题。 如忽略问题，单击“继续导入”。 填写服务名称，或默认系统自动生成的名称。 在“API接口”列表中勾选要开放的API，单击“立即导入”。 （可选）单击“全局配置(可选)”。
在绑定域名前，您需要了解以下2个概念： 调试域名：API服务创建后，系统为服务自动分配一个内部测试用的调试域名，此域名唯一且不可更改。如果您未绑定独立域名，那么调用API时默认使用调试域名，ROMA API对调试域名的访问次数做了限制，每天最多可以访问1000次。
实例是一个独立的资源空间，所有的操作都是在实例内进行，不同实例间的资源相互隔离；应用是一个系统资源的集合，API的全生命周期是在应用中实现。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
