检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
企业API文档规范统一 当今企业随着系统内部功能逐渐增多,子系统数量成倍增长,各个系统间调用依赖愈发重要,此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器,通过规范化、标准化的API文档形成稳定资产,快速完成内部系统对外接口的统一,有效降低开发成本。
流水线任务能力,使后端开发无需从零开始。后端开发流程如下图所示: 图1 后端开发流程图 创建后端 后端是一种以业务功能为主的服务设计概念,每一个后端都具有自主运行的业务功能。同时,后端支持框架代码的查看、删除,以及源码包的下载功能。 在线开发 后端创建完成后,您可以使用“在线开发”开发代码,通过CodeArts
应用 API的全生命周期管理在应用中实现,应用是一个系统资源的集合,即多个区域下,多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管理提供了API
作为中级使用者,在线设计API文件和上架API目录,需要完成以下流程: 图1 中级使用者流程图 步骤一:购买实例 在创建应用前,需要先购买实例。 步骤二:创建应用 应用是一个系统资源的集合,下面可以划分不同的服务。 步骤三:创建API设计 快速在线设计标准的RESTful API。 步骤四:后端开发(可选) 支持一
进。 应用是一个系统资源的集合,API的全生命周期是在应用中实现,因此在开启API的全生命周期管理之前,您需要在“管理中心”先创建应用。 API设计 API设计者主要负责API整体的规划和设计,提前Mock调测和规范检查。 API实现 API开发者负责后端的业务开发、版本测试、验证、版本发布等。
略进行保护。 认证层 提供AK/SK、Token方式进行应用的认证,授权后才可访问;支持系统级和API级的IP黑白名单,拒绝恶意访问。 审计层 支持LTS日志分析,可为追查异常调用和恢复业务操作提供客观依据。 转发层 通过安全通道访问后端服务;提供负载均衡、自动熔断等能力;支持对
在当前应用关联的实例中,根据实际业务选择实例。 单击凭据名称,进入策略详情页面。 在“AppCode”区域,单击“添加AppCode”。 在弹窗中配置AppCode,完成后单击“确定”。 表1 配置AppCode 参数 配置说明 生成方式 选择AppCode的生成方式。 自动生成:由系统随机生成AppCode。
API为企业构建规范化的API全流程体系,将企业服务能力包装成标准API服务,上架市场进行售卖。变现自身服务能力的同时,降低企业研发投入,专注于企业核心业务,提升运营效率。提供全栈的API数据化运营能力,用运行数据驱动规范跟设计的落地,提供更高维度的顶层API架构设计能力。 支持区域:华北-北
前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的认证系统时,导致您需要为不同的认证系统定制化开发API,而APIG通过自定义认证功能,将多种认证系统集成,简
错误码 用户在调用API失败时,系统返回的错误码包含ROMA和APIG的错误码: 在ROMA实例下,系统返回的错误码请参考错误码。 在APIG实例下,系统返回的错误码请参考错误码。 父主题: 调用API
I目录查看和订阅API。此时,部门A通过开放业务能力,使自身服务能力变现,部门B直接订阅部门A开放的API,减少开发时间和成本,实现部门之间业务共享。 前提条件 已创建应用和实例。 开放API A部门将自己的业务变现。 将A部门的业务生成设计文档。 在“API设计”页面,选择“创建API设计
3分钟创建一个游戏类容器应用 3分钟创建一个游戏类容器应用 05 开发指导 为客户端提供Java、Go、Python、C等多语言的SDK接入,业务后端无需做修改,轻松实现一套系统对接多种业务场景(如移动场景、IoT场景等)。 API认证 APP认证工作原理 APP认证-Java IAM认证 其他认证 自定义认证
帮助企业轻松构建、管理和部署不同规模的API。简单、快速、低成本、低风险的实现内部系统集成、成熟业务能力开放及业务能力变现。 使用场景 ROMA Connect实例: 需要解决跨网及多云API业务集成 需要使用丰富的API编排跟数据API服务能力 需要拥有更高的性能跟全栈的应用集成能力
在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 单击页面右上角的“创建API服务 > 导入API设计文件”。 在弹窗中选择要开放API所在的设计文件,单击“确定”。 系统根据默认API导入规则检测API文件。 如需修复问题,单击“修复问题”根据修改建议修改问题。
环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。
r规范性设计API的同时,也可额外自定义扩展字段。 您可以进行以下操作: 规则集管理 启用规则集 根据业务需求选择适用于API设计文件规范性检查的规则集。 创建规则集 根据业务需求创建规则集。 设置无需检查的接口 设置无需规范性检查的接口。 配置扩展字段 支持统一自定义扩展字段,
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析 > API指标”。 在当前应用关联的实例中,根据实际业务选择实例。 单击服务名称,进入到API服务信息页面。 单击“API运行”页签。 在页面左侧选择API。 在“监控视图”区域,查看API的各项监控指标。
服务部署到环境上,同时间接地发布API。 已发布到环境的API,在修改配置信息后,需要重新发布才能将修改后的信息同步到环境中。 前提条件 系统已提供了默认发布环境RELEASE,如果您需要把API发布到其他环境,请提前创建环境。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
的API服务,再通过HTTPMethod和PATH确定唯一的API。 在绑定域名前,您需要了解以下2个概念: 调试域名:API服务创建后,系统为服务自动分配一个内部测试用的调试域名,此域名唯一且不可更改。如果您未绑定独立域名,那么调用API时默认使用调试域名,ROMA API对调
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击页面右上角的“导出”。 在页面中配置导出参数,完成后单击“导出”,导出结果可在页面右侧查看,同时支持下载到本地。