十大功能特性，助力开发者玩转 API Explorer

伴随着我国 API 生态逐渐成熟、市场发展不断完善，API 已广泛应用在以网页、移动应用、后端系统集成为主的众多开发场景中。同时，开发者对 API 的主要诉求已由获取数据能力转变为获取技术能力、甚至业务能力，开发者渴望更加高效便捷的调用方式，除关注 API 产品本身性能外，也愈发关注优质的服务和使用体验。在企业业务需求不断扩大、系统接入的云服务不断增多的同时，企业开发人员需要引入和维护的 API 也越多。开发者面临以下难题：

面对冗杂的 API 说明文档，查阅困难；

调试接口或排除故障时无法可视化处理；

从 0 开始开发底层代码，降低效率；

运维人员需在控制台上配置并管理云资源；

…

为解决开发者的以上难题，华为云 API Explorer 为开发者提供一站式 API 解决方案统一平台，集成华为云服务所有开放 API，支持全量快速检索、可视化调试、帮助文档、代码示例等能力，帮助开发者快速查找、学习 API 和使用 API 开发代码。

01

满足开发者应用开发全场景

华为云 API Explorer 开放平台全方位助力开发者的各类应用开发场景，包括但不限于微服务场景、App 场景、Web 场景、IoT 场景、AI 场景、小程序场景等，支持18大类产品服务，搭载华为云计算、网络、存储、应用服务、软件开发服务、视频、数据库、EI 智能等200+云产品，9100+API、16000+错误码及600+个 SDK。

02

十大功能特性，助力开发者玩转 API Explorer

●API 在线搜索华为云 API Explorer 的 API 在线搜索功能，可帮助开发者快速检索，支持开发者基于 API Explorer 全局搜索云产品服务或 API，同时支持开发者按产品搜索 API。开发者在登录后，也可通过 API Explorer 门户快速查看最近搜索/使用的产品或 API。开发者也可在 API Explorer 上关注常用产品 API。

●API 参数可视化调试API Explorer支持常用 YAML 定义参数表格化、可视化，可见即得的参数描述及示例说明，可帮助开发者快速理解参数结构，并支持开发者在线可视化调试 API，并可根据自动获取的错误码详情，快速定位问题、解决问题，从而提高开发效率。在全新升级的 API Explorer 中，开发者在登录状态下，可自动获取 Region、Token、Project_id 参数值，避免开发者人工查找，提高调试效率。● API 文档API 文档包含了规范的文档结构、接口说明、请求参数/示例、返回参数/示例、错误码、SDK 等，开发者可以快速查阅 API 详情和参数说明，并可通过文档上的相关链接了解云产品的服务功能

●代码示例代码示例功能支持开发者使用 Java、Python、Go、.NET、PHP、C、C++等多种主流开发语言调用 SDK 来访问华为云开放 API，帮助开发者快速了解 API 的底层工作原理，开发者在基于华为云服务进行应用开发时，可以直接引用示例代码，避免开发者重复开发底层代码，提高编程效率。

●SDK 中心华为云全新设计的 SDK V3 版本，提供统一的 SDK 使用方式。开发者可通过添加依赖或下载的方式调用华为云 API，访问华为云应用、资源和数据。SDK 为开发者提供详细的代码示例，便于开发者快速集成、快速开发。

● 错误码搜索查看API Explorer 提供产品全部错误码的搜索查看功能，开发者可基于全局或在产品内搜索错误码，根据错误码说明解决问题。

● API 问答开发者可以使用华为云 API 问答助手，对 API、SDK、报错解决方案、云产品等问题进行咨询，快速获取解决方案，同时开发者可在 API 问答界面中提交工单、提出建议反馈等● API 诊断当开发者开发、调试华为云 API 出现错误时，可使用 API 诊断服务查询解决方案、调用链路、CLS 日志、相似错误码、API 文档等信息。● CLI 参数生成开发者在安装部署、变更升级、扩容等场景下，可以使用命令行的方式调用 OpenAPI，管理和使用各类云服务资源，API 参数可自动生成 CLI 命令行参数，开发者可使用 CLI 示例在线调试。开发者也可以使用华为云命令行工具服务（KooCLI）完成以上操作。

● Terraform Explorer开发者可通过 Terraform 在线、可视化地创建、管理、编排华为云资源，并对其进行版本控制。

03

API Explorer 快速入门

在使用 API Explorer 前，您需要完成如下准备工作：

注册华为账号

https://support.huaweicloud.com/usermanual-account/account_id_001.html
 

完成实名认证

https://support.huaweicloud.com/usermanual-account/account_auth_00001.html
 

创建 IAM 用户并授权

https://support.huaweicloud.com/qs-iam/iam_01_0030.html
 

获取访问密钥（AK/SK）

https://support.huaweicloud.com/devg-apisign/api-sign-provide-aksk.html
 

完成后进入华为云 API Explorer进行调试↓ 码上「进入」↓

以弹性云服务器 -- 查询 API 版本信息列表为例

点击弹性云服务器

点击查询 API 版本信息 – NovaListVersions（查询 API 版本信息列表）

点击“调试”按钮

查看调试结果及错误码

查看代码示例（以 Java 语言为例）

04

小贴士：API Explorer 是否收费？

API Explorer 本身是免费的，但如果您在使用部分接口调用涉及付费云产品，则会产生计费。例如，当您使用 API Explorer 的模板创建代码工程，并将代码工程导入代码仓库时，由于该功能涉及到项目管理和代码托管两个服务，因此可能由于超出这两个服务的免费范围而产生计费。详情请见华为云定价。

审核编辑 黄宇