跳到主要内容

在线调试工具

云开发文档平台提供了在线调试工具，允许开发者在不编写代码的情况下直接测试 HTTP API 接口，快速验证请求参数和查看响应结果。

访问调试工具​

进入接口文档页面​

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

定位调试面板​

调试工具位于接口文档页面的右侧，包含请求配置和响应查看两个主要区域。

使用调试工具​

配置请求参数​

  1. 编辑 API 地址：点击 API 地址上的 Edit 按钮
  2. 设置环境 ID：在 env_id 字段中填写云开发环境 ID
  3. 配置请求体：在 body 中输入接口所需的参数
  4. 发送请求：点击 SEND API REQUEST 按钮
  5. 查看响应：在 RESPONSE 面板中查看接口返回结果

参数配置说明​

根据接口要求配置以下参数：

  • 路径参数：直接在 URL 中修改
  • 查询参数：在 URL 后添加查询字符串
  • 请求头：设置必要的 Header 信息
  • 请求体：填写 JSON 格式的请求数据

💡 注意：env_id 是必填参数，需要填写您的云开发环境 ID

响应结果分析​

状态码检查​

查看 HTTP 状态码判断请求是否成功：

  • 200：请求成功
  • 400：请求参数错误
  • 401：认证失败
  • 500：服务器内部错误

响应数据解析​

在 RESPONSE 面板中查看：

  • 响应头：包含服务器返回的元信息
  • 响应体：包含接口返回的具体数据
  • 执行时间：请求处理耗时

错误排查​

如果请求失败，可通过以下方式排查：

  1. 检查请求参数是否正确
  2. 确认环境 ID 是否有效
  3. 查看错误信息和状态码
  4. 参考接口文档确认参数格式

前置条件​

⚠️ 注意：使用 Web 调试工具前，需要将 docs.cloudbase.net 添加到 WEB 安全域名中