检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
要取决于Swagger文件中包含的API数量。 前提条件 已获取待导入API的Swagger文件。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击页面右上角的“导入API”,具体操作请参考导入Swagger文件。 后续操作 将导入成
API开放 安全性 可用性 可维护性 生命周期管理 父主题: 规范要求
API网关代理 概述 API分组 API列表 API策略 API凭据管理 调用已发布的API
如果您需要在API中心门户网站搜索需要的API,用于系统集成和项目开发,请参考本章指导操作。 操作步骤 访问API中心门户网站。 搜索您需要的API。 您可以选择搜索栏搜索或按不同维度搜索API。 搜索栏搜索:输入您需要的API的一些关键信息,如API名称、描述等,系统会展示相关的搜索结果。 按不同维度搜索:
API分组 创建API分组 域名管理 环境变量 父主题: API网关代理
应用场景 API设计开发 当前面临的主要问题 缺少高效的生产作业平台。 多系统数据不互通、学习成本高、数据一致性困难、效率低、无法团队协作。 API中心解决方案 API中心从华为云或生态伙伴选型轻量化、具备便捷开发体验(高效协同、自动化等)的API工具,并对接集成引入到API中心的API工具库,供API开发者使用。
哪些API支持在线调测? API中心服务商在上架API资产时,如果提供了符合Swagger 2.0/OpenAPI 3.0规范的API文件,且提供了API资产的访问域名,则该API可以在线调测。 父主题: API网关代理
现网API版本一般保留3个版本或以下,如果超过3个版本会增加API本身的维护量,建议对旧版本API进行下线处理。 服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户端的契约,不能单方面破坏契约。通过如下的方式来保证向后的兼容性: 遵循兼容扩展标准。 忽略请求/响应中的未知字段。
(可选)配置默认后端的系统参数。如果后端服务需要接收系统运行时产生的参数信息,如网关内置参数,可以通过设置系统参数来实现。API网关代理向后端服务发送请求时,将系统参数添加到请求的指定位置,然后将请求发送给后端服务。 在“系统参数”下,单击“添加系统参数”,添加后端服务请求的系统参数。 表7
AZ内集群容灾 通过集群提供服务,集群中每个微服务都有多个实例,当一个或部分实例异常时,其他实例可以持续提供服务。 数据容灾 数据存储在RDS服务中,RDS实现了AZ容灾方案,数据持续会同步到容灾站点,当生产站点的RDS异常后,容灾站点可以接管业务,保障云服务持续运行。 父主题: 安全
览、搜索API,通过华为云账号登录后,还可进行在线调测、购买或申请凭证等。 API提供方可在API中心完成API发布、变更、下线等生命周期管理。 操作指导 相关操作指导,请参考华为云帮助中心API Hub。 父主题: 附录-API治理规范指导
产品优势 API生产便捷高效 通过对接集成,API中心为开发者引入API生产工具:API Arts。 API设计、测试一站式高效协同,API数据自动同步。 API设计与文档实时同步,设计即文档。 API测试与设计同源,设计示例一键导入测试步骤。 API开放简单体验 一键上架:API
调用API API发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 约束与限制 如果您使用系统分配的默认子域名访问API,该子域名每天最多可以访问1000次。 前提条件 在调用API前,确保您所在网络与API的访问域名或地址互通。 获取API的调用信息
图1 取消入驻 在方框中输入“我确认要取消入驻API中心服务商”(可单击右侧复制文字),单击“确定”。 图2 确认取消入驻 取消入驻成功后,系统提示“取消入驻成功”,并返回入驻API中心服务商界面。 父主题: 服务商
提供商业变现通道。 华为云集成工作台 API中心可以通过对接aPaaS集成工作台的集成框架,支持aPaaS集成工作台获取并使用API资产元数据,用于连接器的创建和使用。
您的服务能力变现,同时降低企业研发投入,让您专注于企业核心业务,提升运营效率。 消费API:在API中心门户网站中搜索您需要的API,用于系统集成和项目开发使用。
选择JSON或YAML。 自定义版本 为导出的API自定义版本号,如果没有指定版本号,默认使用当前时间。 单击“导出”,右侧显示导出结果,并自动下载文件。 父主题: API列表
的一个公共服务,是所有API注册和发布的入口。 JSON JSON(JavaScript Object Notation) 是一个轻量级的数据交换格式,它易于人类读写及其解析生成。 HTTP HTTP(Hyper Text Transfer Protocol)是超文本传输协议。 HTTPS
值为准。 查看已发布API被调用情况 如果您想要查看已发布的API被调用的情况,如API被请求调用的次数,调用失败的次数等,可以参考API数据分析章节指导操作。 父主题: API列表
PI描述应为“通过虚拟机名称、IP地址、虚拟机型号查询当前租户下的虚拟机列表,列表包括虚拟机名称,所属VPC、虚拟机IP、虚拟机型号、操作系统版本。” API文档按照模板进行写作 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 API对外开放时,API文档建