正在生成
详细信息:
检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API提供了API设计文件规范性检查,帮助用户快速设计标准的RESTful API。您可以选择已有的规则集或者新建规则集对API设计文件进行规范性检查。 ROMA API也支持配置扩展字段,您按照Swagger规范性设计API的同时,也可额外自定义扩展字段。 您可以进行以下操作: 规则集管理 启用规则集 根据业务需
在API创建后,您需要把API发布到环境,API只有在发布到环境后,才支持被其他用户调用。 作为初级使用者,成功创建API后,您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者,在创建API服务时,您可以把服务部署到环境上,同时间接地发布API。 已发布到环境的API,在修改配置信息后,需要重新发布才能将修改后的信息同步到环境中。
IP地址和账户,您可以创建访问控制策略,允许/禁止某个IP地址或账号访问绑定策略的API。 每个用户最多可以创建100个访问控制策略。 API添加访问控制策略相当于访问控制策略同步绑定了API。同一个环境中一个API只能添加一个访问控制策略,一个访问控制策略可以添加到多个API上。
... } } doFilter函数为签名校验代码。校验流程如下:由于filter中需要读取body,为了使得body可以在后续的filter和controller中再次读取,把request包装起来传给后续的filter和controller。包装类的具体实现可见RequestWrapper
创建环境 创建环境后,在创建API服务或发布API时,可以直接将API部署到环境上。 前提条件 已创建ROMA Connect实例。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。
API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击产品右侧的“订阅”。 在弹框中选择版本号和凭证,填写申请描述。 您可以使用已有的凭证或者新建凭证,新建凭证具体操作请参考创建凭证。 单击“确定”,订阅申请成功。 在左侧导航栏单击“审核管理”,审核申请通过后,订阅产品完成。
本文介绍了ROMA API提供的开放API的SDK语言版本,列举了最新版本SDK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表,您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址
HTTP响应头管理策略 API响应是指ROMA API返回客户端的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头(x-apig-*,x-request-id等),包括ROMA
管理”进行授权配置。 主账号可以对所有IAM用户创建的应用进行授权配置,IAM用户只能对自己创建的应用进行授权配置。 在弹窗中“用户列表”处勾选要授权的IAM用户,在“已选择”处为已选择的IAM用户配置应用的使用权限。 可为每个用户单独配置权限,也可以单击“权限”右侧的为所有已选择IAM用户批量配置权限。
se信息。 调试失败时,返回HTTP状态码为4xx或5xx,具体错误信息请参考错误码。 您可以通过调整请求参数与参数值,发送不同的请求,验证API服务。 后续操作 API调试成功后,您可以发布API到环境上。 父主题: APIs管理
息以及通过该凭证订阅的产品信息。 单击“创建凭证”,填写凭证基本信息。 图1 填写基本信息 单击“确定”,创建完成。 凭证创建完成后,您还可以执行如下列操作。 去订阅 通过已创建凭证订阅API产品。 重置Secret 在“凭证信息”区域,凭证“Key”和“Secret”是创建凭证
绑定域名 您需要为API服务绑定一个或多个独立域名,每个API服务最多可以绑定5个独立域名,同一独立域名只能绑定一个服务。绑定域名即在域名和服务之间建立映射关系,将已有的独立域名绑定到API服务上。当客户端发送请求时,根据HTTP请求中的域名定位到所属的API服务,再通过HTTP
配置环境和环境变量 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境
应参数。 开启绿色通道后,需要设置白名单和黑名单。白名单中的地址可以不用认证即可调用API;黑名单中的地址不允许调用API。 单击“确定”,完成授权。 下线API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 选择需要下线的API。 单击“下线”,选择需要下线的环境。
审核管理 为产品上架/不推荐/下架/订阅过程提供审核机制,API管理者发起上架/不推荐/下架/订阅请求时,IAM用户(其他管理者)都可以参与到评审中,让更多用户参与到API产品审视中,以确保产品的正确性。 审核流程: 提交申请 查看申请 审核申请 提交申请 登录ROMA API控制台。
自定义认证包含两种认证:前端自定义认证和后端自定义认证。 前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的认证系统时,导致您需要为不同的认证系统定制化开
部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 HTTP响应头管理策略 3 SLA配置 提前设计接口运行的可靠性和性能指标。 配置SLA 4 导入规则检查 系统根据默认API导入规则,检测API文件。 导入到API服务 5 后端开发 用户可以快速生成代码,并完成后端的服务能力开发。
如果产品已上架,那么需要提交修改申请。 填写申请描述后,单击“确定”。 审核申请通过后,产品信息编辑成功。 删除 API产品不再提供服务,且产品已下架,可以将API产品删除。 在API产品所在行,单击“删除”。 确认删除产品信息后,单击“确定”。 不推荐 不推荐表示产品待下架。待下架的产品不推
支持编辑或修改应用名称和描述。 在搜索框中输入需要编辑的应用名称。 单击对应应用所在行的“编辑”,即可编辑应用信息。 删除应用 已创建的应用不再提供服务,可以将应用删除。 在搜索框中输入需要删除的应用名称。 单击对应应用所在行的“删除”,即可删除应用信息。 更新应用 刷新全局应用信息。 在页面右上角单击刷新应用列表。
API产品是从服务中挑选想要共享的API组合而成,即为将要上架的API的集合。 API目录 API目录用于帐号内部的API产品共享,IAM用户可以通过订阅不同的API产品实现API共享。 实例 实例是一个独立的资源空间,所有的操作都是在实例内进行,不同实例间的资源相互隔离。