检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
企业内部开放API及文档 本章节讲述企业内部如何开放API及文档。企业内部之间通过ROMA API将服务或数据变现,内部之间相互调用实现资源共享。 例如,部门A在ROMA API开放API,设计API、生成产品并上架到API目录,部门B通过API目录查看和订阅API。此时,部门A
SDK概述 本文介绍了ROMA API提供的开放API的SDK语言版本,列举了最新版本SDK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表,您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言
创建API 您可以通过创建API,把已有后端服务封装成标准的RESTFul API,并开放给其他用户使用。 创建API主要步骤:设置前端定义和安全配置和后端配置。 前提条件 已创建API服务。如果未创建API服务,请参考创建API服务。 如果后端服务需要使用VPC通道,请参考创建负载通道。
导入API设计文件”。 在弹窗中选择要开放API所在的设计文件,单击“确定”。 系统根据默认API导入规则检测API文件。 如需修复问题,单击“修复问题”根据修改建议修改问题。 如忽略问题,单击“继续导入”。 填写服务名称,或默认系统自动生成的名称。 在“API接口”列表中勾选要开放的API,单击“立即导入”。
根据下表相关任务,了解如何管理API设计文件。 表1 管理API设计 相关任务 使用场景 操作步骤 导入到API服务 从API设计文件中挑选部分API接口生成API服务,开放给其他用户使用。 单击对应API设计文件所在行的“导入到API服务”。或单击“编辑器”/“表单”页面中的“导入到API服务”。 导入规则检测通过后,单击“继续导入”。
API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管理提供了API服务开放、配置运行策略、API安全配置等能力。 API消费 API消费用于帐号内部的API产品上架和订阅。 API分析 API分析提供了API指标分析。
实现内部系统集成、成熟业务能力开放及业务能力变现。 使用场景 ROMA Connect实例: 需要解决跨网及多云API业务集成 需要使用丰富的API编排跟数据API服务能力 需要拥有更高的性能跟全栈的应用集成能力 APIG实例: 需要实现API的开放托管,安全等配置 使用一些基础的API编排集成能力
Continuous Delivery持续集成)能力高效完成产品研发,并实现开发、测试、运行的并行操作,大大提升了产品的研发效率。 多重运行安全防护 API的开放无时无刻都在面临着巨大的安全攻击风险(DDoS、XSS、钓鱼、暴力攻击等),ROMA API提供了一套完善的4层防护架构,从接入层、认证层
API管理 包括API的创建、发布、下线和删除的完整生命周期管理,提供便捷的在线调试能力,支持导入Swagger文档一键生成API,以便更快速地开放API业务。 API策略 支持传统策略和插件策略。传统策略包括流量控制、访问控制、签名密钥;插件策略包括跨域资源共享、HTTP响应头管理以
ROMA API对调试域名的访问次数做了限制,每天最多可以访问1000次。 独立域名:您自定义的域名,API调用者通过访问独立域名来调用您开放的API。 前提条件 已备案独立域名,未备案的独立域名无法被访问。 已经将独立的域名解析到该服务的实例IP上,具体方法请参考增加A类型记录集。
上海二、华南-广州、乌兰察布二零二 创建后端 VPC服务介绍【视频】 OBS 2.0支持API管理 主要介绍API管理者如何通过API管理开放API的服务与数据,实现业务能力变现。 支持区域:华北-北京一、华北-北京四、华东-上海一、华东-上海二、华南-广州、乌兰察布二零二 创建API服务
其他认证:向API管理者获取该API所授权应用的Key和Secret(或客户端的AppKey和AppSecret)或凭证信息。 华为IAM认证:通过云服务平台的账号凭证(账号和密码获取Token或者AK/SK)进行认证。如果使用AK/SK进行认证,还需要向API管理者获取用于调用API的SDK。
参与到API产品审视中,以确保产品的正确性。 审核管理 2021年4月 序号 功能模块 功能描述 相关文档 1 API测试 一站式云端测试平台。 API测试 2021年3月 序号 功能模块 功能描述 相关文档 1 API设计 支持API整体的规划和设计,提供Mock调测和规范性检查。
自定义认证依赖函数服务。如果当前Region没有上线函数服务,则不支持使用自定义认证。 自定义认证的具体使用指导,可参考《 应用与数据集成平台 ROMA Connect 开发指南》的自定义认证相关章节。 前提条件 已在函数工作流服务中完成函数创建。 操作步骤 登录ROMA API控制台。
步骤四:后端开发(可选) 支持一站式创建代码仓、自动生成框架代码、创建编译构建等流水线任务能力。 步骤五:创建API服务 将已创建的API设计文件导入API服务,开放给消费者使用。 步骤六:配置策略 为API绑定流控策略,对API进行流量限制。 步骤七:调试API 您可以在线调试API,确保API的功能正常。