检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
提供AK/SK、Token方式进行应用的认证,授权后才可访问;支持系统级和API级的IP黑白名单,拒绝恶意访问。 审计层 支持LTS日志分析,可为追查异常调用和恢复业务操作提供客观依据。 转发层 通过安全通道访问后端服务;提供负载均衡、自动熔断等能力;支持对后端服务的证书校验;提供API网关的身份认证信息、签名密钥等功能。
企业API文档规范统一 当今企业随着系统内部功能逐渐增多,子系统数量成倍增长,各个系统间调用依赖愈发重要,此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器,通过规范化、标准化的API文档形成稳定资产,快速完成内部系统对外接口的统一,有效降低开发成本。
前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的认证系统时,导致您需要为不同的认证系统定制化开发API,而APIG通过自定义认证功能,将多种认证系统集成,简
错误码 用户在调用API失败时,系统返回的错误码包含ROMA和APIG的错误码: 在ROMA实例下,系统返回的错误码请参考错误码。 在APIG实例下,系统返回的错误码请参考错误码。 父主题: 调用API
步骤一:购买实例 在创建应用前,需要先购买实例。 步骤二:创建应用 应用是一个系统资源的集合,下面可以划分不同的服务。 步骤三:创建API设计 快速在线设计标准的RESTful API。 步骤四:后端开发(可选) 支持一站式创建代码仓、自动生成框架代码、创建编译构建等流水线任务能力。 步骤五:创建API服务
时,才可以选择此参数。 系统参数名 填写系统参数的名称。 系统参数类型为“网关内置参数”时,选择系统支持获取的参数。 系统参数类型为“前端认证参数”或“后端认证参数”时,支持自定义参数,但是此参数必须为自定义认证返回结果中的参数。 后端参数名称 填写系统参数需要映射的后端参数名称。
费的风险。 支持简易认证 简易认证指APP认证方式下调用API时,在HTTP请求头部消息增加一个参数X-Apig-AppCode,而不需要对请求内容签名,ROMA API也仅校验AppCode,不校验请求签名,从而实现快速响应。 注意仅支持HTTPS方式调用,不支持HTTP方式。具体使用请参考管理应用。
app_route 支持IP访问开关。启用后,非DEFAULT服务下的API可以使用IP地址调用。 backend_client_certificate 后端双向认证开关。启用后,创建API配置后端服务时,可配置后端双向认证。 ssl_ciphers 可支持配置的https加密套件,可根据需要选择开启的加密套件。
API返回客户端的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头(x-apig-*,x-request-id等),包括ROMA API提供的CORS功能增加的响应头。 配置参数说明 表1 配置参数说明
的交付质量。 支持区域:华北-北京一、华北-北京四、华东-上海一、华东-上海二、华南-广州、乌兰察布二零二 创建API设计 管理规则集 OBS 2.0支持API实现 提供一站式创建代码仓、自动生成框架代码、创建编译构建等流水线任务能力,使后端开发无需从零开始。 支持区域:华北-北
环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。
基本概念 应用 API的全生命周期管理在应用中实现,应用是一个系统资源的集合,即多个区域下,多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管
入请求体。 未定义Body 通过POST/PUT/PATCH方法请求的API支持展示自定义填写。 说明: 如果API已定义formData类型参数,将不展示Body参数,且暂不支持调试。 IAM认证 支持Token认证或AK/SK认证。Explorer自动获取或临时生成Token或AK/SK。
管理实例 实例购买完成后,在“实例管理”页面显示新创建实例的基本信息卡片,同时也支持查看实例详情、编辑实例、删除实例等操作管理实例。 前提条件 已购买实例。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域。 在左侧导航栏选择“管理中心 > 实例管理”。 根据下表相关任务,了解如何管理实例。
功能描述 相关文档 1 API设计 支持API整体的规划和设计,提供Mock调测和规范性检查。 API设计 2 API管理 支持API服务和API策略能力,提供API服务定义和策略管理。 支持API创建、调试和发布功能。 API管理 3 API消费 支持从服务中挑选的部分API组合成A
在当前应用关联的实例中,根据实际业务选择实例,查看当前实例下包含的API,以及API基本信息。 单击API名称,查看API详情。 支持批量发布、下线、删除API。 单个支持编辑、调试、授权等操作,可参见APIs管理。 父主题: API管理
创建SSL证书 如果API服务中的API支持HTTPS请求协议,则在绑定独立域名后,还需为独立域名添加SSL证书。 前提条件 仅支持添加pem编码格式的SSL证书。 添加的SSL证书仅支持RSA、ECDSA和DSA加密算法。 创建SSL证书 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
API提供了可视化的API在线设计能力,及接口规范性检查,帮助用户快速设计标准的RESTful API。在开始设计API前,您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。 本地已存在API设计文件可单个导入Swagger文件或批量导入Swagger文件。
发布API 在API创建后,您需要把API发布到环境,API只有在发布到环境后,才支持被其他用户调用。 作为初级使用者,成功创建API后,您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者,在创建API服务时,您可以把服务部署到环境上,同时间接地发布API。
<activeProfile>MyProfile</activeProfile> </activeProfiles> IDEA的配置方式 支持以下几种配置方式,用户可根据业务需求选择。 导入示例代码 创建IDEA maven工程 导入示例代码 打开IDEA,在菜单栏选择“File >