快速入门
OpenAPI Explorer 是百度智能云提供的一站式 API 探索与开发工具。您可以通过可视化页面选择云产品 API、查看接口文档、填写请求参数并发起在线调用,也可以生成 SDK 示例代码或 CLI 命令,用于本地开发、自动化测试与系统集成。
本文介绍如何从零开始使用 OpenAPI Explorer 完成一次 OpenAPI 在线调试。
使用准备
使用 OpenAPI Explorer 前,您需要拥有百度智能云账号并完成实名认证。
- 注册并登录百度智能云平台。
- 完成实名认证。
- 登录成功后,进入 OpenAPI Explorer 。
在线调试 API
登录 OpenAPI Explorer 后,选择目标云产品,例如“私有网络”。
选择需要调用的 API,例如“创建 VPC(createVpc)”。如果接口较多,可通过搜索框输入中文名称或英文方法名快速查找。
选择接口后,可查看“文档说明”,了解接口用途、请求参数、返回参数、示例和错误码。根据文档要求填写参数后,单击“发起调试”。
注意:在线调用会实际操作云资源。例如调用创建类接口会真实创建资源,请谨慎填写参数。
查看调用结果
发起调用后,可在“调试结果”中查看接口返回内容。
调用成功时,页面会展示接口返回数据。调用失败时,页面会展示错误码和错误信息,可根据提示检查参数配置。
更多功能
SDK 示例
在“SDK 示例”中,可查看 Java、Go、Python 等语言的调用代码。
可复制示例代码,也可以下载完整工程文件,用于后续项目集成。
CLI 示例
如需通过命令行调用 API,可在“CLI 示例”中查看根据当前参数生成的 BCE CLI 命令。
复制命令后,可在已配置 BCE CLI 的本地终端中执行。
调用历史
在“调用历史”中,可查看历史请求记录,回溯历史请求参数和调用结果。
如需复现问题,可回填历史参数并重新调试。
签名工具
OpenAPI Explorer 在线调用时无需用户手动计算签名。
当自行集成 OpenAPI 并遇到签名或鉴权问题时,可使用“签名工具”校验签名计算过程,辅助定位问题。
评价此篇文章
