本文为您介绍如何测试开发中和已发布的API。

测试开发中的API

测试开发中的API是指在服务开发页面(即开发环境)进行测试,您需要先生成或注册API。

  1. 进入数据服务页面。
    1. 登录DataWorks控制台
    2. 在左侧导航栏,单击工作空间列表
    3. 选择工作空间所在地域后,单击相应工作空间后的进入数据服务
  2. 服务开发页面的API列表中,双击开发中的API名称。
  3. 在API的编辑页面,单击右上方的测试
    测试
  4. API测试对话框中,单击开始测试,在线发送API请求。
    您可以在右侧查看API的请求详情返回内容。如果测试失败,请仔细查看错误提示,进行相应的修改并重新测试。
    您可以根据自身需求,确认是否选中自动保存正常返回示例
    • 配置API后,系统会自动生成异常返回示例和错误码,但无法自动生成正常返回示例。

      您需要在开始测试前选中自动保存正常返回示例,保存当前的测试结果为正常返回示例。如果返回结果中有敏感数据需要脱敏,请手动修改。

    • 正常返回示例对于API的调用者来说,具有非常重要的参考意义,请务必配置。
    • API调用延迟是本次API请求的延迟,供您评估的API性能。如果延迟较大,则需要考虑进行数据库优化。

测试已发布的API

测试已发布的API是指在服务管理页面(即生产环境)进行测试,您需要先发布API。详情请参见发布API

  1. 数据服务页面,单击右上方的服务管理
  2. 在左侧导航栏,单击API测试
  3. 从下拉列表中选择需要测试的API,并确认API的请求参数的值已配置完整。
    请求参数
  4. 单击开始测试,在右侧查看请求详情返回内容
    说明 API测试页面仅提供API在线测试功能,不支持更新API正常返回示例。