跳到主要内容

接口在线调试

接口调试工具介绍​

云开发平台提供了一个在线调试工具，允许开发者在不编写任何代码的情况下测试 API 接口。这个工具对于快速验证 API 请求和查看响应非常有用。

访问调试界面​

打开 HTTP 接口文档页面​

我们在 HTTP 接口文档页面直接集成了调试工具，可以直接进行调用，例如 用户认证/Sign In By Email/Phone/Username 接口可以在线进行测试。

定位调试工具​

在管理界面中，找到 API 调试工具的入口，通常位于文档的右侧

发送请求​

    1. 点击 API 地址上的 Edit
    1. 输入 env_id: 填写自己的云开发环境的 id
    1. 在 body 中输入参数
    1. 点击 SEND API REQUEST 发送请求
    1. 查看 RESPONSE 接口响应

选择 API 接口​

在调试工具中，选择您想要测试的 API 接口。

配置请求参数​

根据所选 API 的要求，填写必要的请求参数。这可能包括路径参数、查询参数、请求头和请求体。

  • 输入 env_id: 填写自己的云开发环境的 id
  • 在 body 中输入参数

发送请求​

点击“SEND API REQUEST”按钮，您的请求将被发送到服务器，并且您可以立即看到响应。

查看和分析响应​

RESPONSE 面板中会返回接口的响应

查看响应状态码​

检查响应的 HTTP 状态码，以确定请求是否成功。

分析响应体​

查看响应体中的数据，分析返回的信息是否符合预期。

调试信息​

如果请求失败，查看错误信息和文档，以帮助诊断问题。

注意事项​

在 Web 调试之前，需要把 docs.cloudbase.net 加入 WEB 安全域名,请参考 配置安全域名