检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建后端 “后端开发”为您提供业界主流框架代码初始化能力,提供一站式创建代码仓、自动生成框架代码、创建编译构建等流水线任务能力,使后端开发无需从零开始。后端开发流程如下图所示: 图1 后端开发流程图 创建后端 后端是一种以业务功能为主的服务设计概念,每一个后端都具有自主运行的业务
创建API设计 ROMA API提供了可视化的API在线设计能力,及接口规范性检查,帮助用户快速设计标准的RESTful API。在开始设计API前,您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。 本地已存在API设计
错误码 用户在调用API失败时,系统返回的错误码包含ROMA和APIG的错误码: 在ROMA实例下,系统返回的错误码请参考错误码。 在APIG实例下,系统返回的错误码请参考错误码。 父主题: 调用API
认证系统时,导致您需要为不同的认证系统定制化开发API,而APIG通过自定义认证功能,将多种认证系统集成,简化API开发的复杂度。您只需要在ROMA API中创建自定义的函数认证,ROMA API通过此函数对接后端认证系统,获取后端服务的访问授权。 自定义认证依赖函数服务。如果当
创建API 您可以通过创建API,把已有后端服务封装成标准的RESTFul API,并开放给其他用户使用。 创建API主要步骤:设置前端定义和安全配置和后端配置。 前提条件 已创建API服务。如果未创建API服务,请参考创建API服务。 如果后端服务需要使用VPC通道,请参考创建负载通道。
企业API文档规范统一 当今企业随着系统内部功能逐渐增多,子系统数量成倍增长,各个系统间调用依赖愈发重要,此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器,通过规范化、标准化的API文档形成稳定资产,快速完成内部系统对外接口的统一,有效降低开发成本。
发布API 在API创建后,您需要把API发布到环境,API只有在发布到环境后,才支持被其他用户调用。 作为初级使用者,成功创建API后,您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者,在创建API服务时,您可以把服务部署到环境上,同时间接地发布API。
创建环境 创建环境后,在创建API服务或发布API时,可以直接将API部署到环境上。 前提条件 已创建ROMA Connect实例。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。
境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 当创建API时定义了变量标识,则需要在环境中添加变量。例如创建API时定义了变量名为“
阅的产品信息。 单击“创建凭证”,填写凭证基本信息。 图1 填写基本信息 单击“确定”,创建完成。 凭证创建完成后,您还可以执行如下列操作。 去订阅 通过已创建凭证订阅API产品。 重置Secret 在“凭证信息”区域,凭证“Key”和“Secret”是创建凭证后自动生成的,如需
创建SSL证书 如果API服务中的API支持HTTPS请求协议,则在绑定独立域名后,还需为独立域名添加SSL证书。 前提条件 仅支持添加pem编码格式的SSL证书。 添加的SSL证书仅支持RSA、ECDSA和DSA加密算法。 创建SSL证书 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
API返回客户端的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头(x-apig-*,x-request-id等),包括ROMA API提供的CORS功能增加的响应头。 配置参数说明 表1 配置参数说明
如果策略与API有绑定关系,则策略无法执行删除操作。 创建策略 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API策略”。 在当前应用关联的实例中,根据实际业务选择实例。 单击“创建策略”,选择策略类型。 插件策略
作为中级使用者,在线设计API文件和上架API目录,需要完成以下流程: 图1 中级使用者流程图 步骤一:购买实例 在创建应用前,需要先购买实例。 步骤二:创建应用 应用是一个系统资源的集合,下面可以划分不同的服务。 步骤三:创建API设计 快速在线设计标准的RESTful API。 步骤四:后端开发(可选) 支持一
凭据策略分三种类型:集成凭据、订阅凭据和客户凭据(集成凭据由ROMA实例下的集成应用同步创建;订阅凭据通过订阅产品后,在产品所属实例下同步创建;客户凭据由租户管理员在APIG实例下创建)。 添加AppCode 使用APP认证方式的API,支持通过AppCode进行API调用的简易安全认证。
在域名和服务之间建立映射关系,将已有的独立域名绑定到API服务上。当客户端发送请求时,根据HTTP请求中的域名定位到所属的API服务,再通过HTTPMethod和PATH确定唯一的API。 在绑定域名前,您需要了解以下2个概念: 调试域名:API服务创建后,系统为服务自动分配一个
Connect源自华为10年+数字化转型实践。聚焦应用和数据联接,提供消息、数据、API、设备集成能力,帮助企业快速、简单的打通并管理Legacy系统与CloudNative应用,联接云上云下,消除数字鸿沟,构建业务敏捷性,驱动数字化转型。 APIG实例 API网关(API Gatewa
防篡改;从APP、API、IP等多维度设置的流控策略进行保护。 认证层 提供AK/SK、Token方式进行应用的认证,授权后才可访问;支持系统级和API级的IP黑白名单,拒绝恶意访问。 审计层 支持LTS日志分析,可为追查异常调用和恢复业务操作提供客观依据。 转发层 通过安全通道
基本概念 应用 API的全生命周期管理在应用中实现,应用是一个系统资源的集合,即多个区域下,多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管
根据下表参数说明,配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明,请参考实例配置参数说明。 参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数的最近一次更新时间。若参数从未修改过,该更新时间为空。