检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
登录ROMA API控制台,单击,选择区域。 在左侧导航栏选择“管理中心 > 实例管理”。 单击“购买实例”。 选择实例类型,以APIG实例为例。 购买实例。 创建APIG实例。 图2 配置实例信息 表1 配置实例信息 参数 配置说明 计费模式 选择实例的计费模式,此处选择“按需计费”。 区域
使用自定义认证调用API Function API通过编写函数脚本实现将多个服务封装成一个服务。 有关API调用的认证帮助,请参考编写函数API脚本(Java Script)。
跨域资源共享 浏览器出于安全性考虑,会限制从页面脚本内发起的跨域访问(CORS)请求,此时页面只能访问同源的资源,而CORS允许浏览器向跨域服务器,发送XMLHttpRequest请求,从而实现跨域访问。 前提条件 API已发布。 配置跨域访问控制 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
创建凭证 凭证代表用户认证标识,用户通过凭证来订阅上架的产品,订阅后方可调用对应产品下的API。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击“订阅与凭证”页签。
配置环境和环境变量 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境
签名密钥 签名密钥用于后端服务验证API的身份,在API请求后端服务时,保障后端服务的安全。 签名密钥是由一对Key和Secret组成,当签名密钥创建后,ROMA API向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果与
生成产品 ROMA API支持把API服务中的API资源作为一个产品,共享给其他用户使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。
创建后端 “后端开发”为您提供业界主流框架代码初始化能力,提供一站式创建代码仓、自动生成框架代码、创建编译构建等流水线任务能力,使后端开发无需从零开始。后端开发流程如下图所示: 图1 后端开发流程图 创建后端 后端是一种以业务功能为主的服务设计概念,每一个后端都具有自主运行的业务
创建SSL证书 如果API服务中的API支持HTTPS请求协议,则在绑定独立域名后,还需为独立域名添加SSL证书。 前提条件 仅支持添加pem编码格式的SSL证书。 添加的SSL证书仅支持RSA、ECDSA和DSA加密算法。 创建SSL证书 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
上架目录 将API产品上架到API目录,供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 选择需要上架的API产品,单击产品名称。 在“版本列表”中,选择上架版本,单击“上架”。
流量控制 流量控制支持从用户、应用和时间段等不同的维度限制对API的调用次数,保护后端服务。支持按分/按秒粒度级别的流量控制。为了提供持续稳定的服务,您可以通过创建流控策略,针对部分API进行流量控制。 每个用户最多创建30个流控策略。 API添加流控策略相当于流控策略同步绑定了
策略管理 创建API策略 跨域资源共享策略 HTTP响应头管理策略 管理API策略 父主题: API管理
管理SSL证书 SSL证书创建完成后,在证书列表中显示新创建证书信息,同时也支持编辑、删除操作管理证书。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API策略”。 在当前应用关联的实例中,根据实际业务选择实例。
管理自定义认证 API自定义认证创建完成后,在自定义认证列表中显示新创建认证信息,同时也支持编辑、删除、更新等操作管理自定义认证。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API策略”。
自定义认证 创建自定义认证 管理自定义认证 父主题: API管理
SSL证书管理 创建SSL证书 管理SSL证书 父主题: API管理
管理中心 实例管理 应用管理
应用场景 企业API文档规范统一 当今企业随着系统内部功能逐渐增多,子系统数量成倍增长,各个系统间调用依赖愈发重要,此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器,通过规范化、标准化的API文档形成稳定资产,快速完成内部系统对外接口的统一,有效降低开发成本。
认证前准备 APP认证方式调用API,需要提前获取如下信息: 访问服务前,首先需要得到API的请求方法和请求url。 在API服务详情中的“API运行”页面,查看对应API的请求方法和请求url。 图1 API基础定义 您必须将API发布到环境才能访问。 在API服务详情中的“API运行”页面,查看已发布的环境。
创建环境 创建环境后,在创建API服务或发布API时,可以直接将API部署到环境上。 前提条件 已创建ROMA Connect实例。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。