pingcode导航 [已恢复]3
功能日记

REST API v1.12.0:Testhub部分能力开放


在本次版本更新中,REST API开放了Testhub的部分能力。

主要API一览:

查看测试库
GET /testhub/libraries
GET /testhub/libraries/{library_id}

查看测试库成员
GET /testhub/libraries/{library_id}/members
GET /testhub/libraries/{library_id}/members/{member_id}

查看和管理测试计划
POST /testhub/libraries/{library_id}/plans
PATCH /testhub/libraries/{library_id}/plans/{plan_id}
GET /testhub/libraries/{library_id}/plans
GET /testhub/libraries/{library_id}/plans/{plan_id}

查看测试用例
GET /testhub/cases
GET /testhub/cases/{case_id}

查看和管理运行用例
POST /testhub/libraries/{library_id}/plans/{plan_id}/runs
PUT /testhub/libraries/{library_id}/plans/{plan_id}/runs/{run_id}
GET /testhub/libraries/{library_id}/plans/{plan_id}/runs
GET /testhub/libraries/{library_id}/plans/{plan_id}/runs/{run_id}

支持的典型场景

REST API的目标之一是打通企业内部和PingCode的数据,通过自动化的方式提升企业效能。而本次开放的API支持的一个典型场景是:将自动化测试的测试结果记录到Testhub中

首先在使用REST API前需要做一些准备工作:

1.在PingCode Testhub中创建一个测试库“自动化测试库”。

2.在测试库中加入相关的测试用例。例如:注册新账号、登录系统等等。

3.写测试脚本(例如python脚本)。测试脚本的工作过程如下:

1)通过REST API创建一个测试计划,关联到项目x。

2)通过REST API将相关的测试用例放入测试计划中(创建运行用例)。

3)分别按每一个测试用例进行测试,将结果通过REST API更新到运行用例中。

4)通过REST API更新测试计划状态,生成测试报告

然后在项目x提测时执行脚本,或者持续部署时自动执行脚本。

最后在PingCode Agile的“项目x”中,点击上方“测试”即可查看所有的测试计划:

点击一个测试计划查看完整的测试报告:

详细说明

1.查看测试库

您可以使用REST API获取测试库信息。目前对外开放的测试库属性包括:名称、主题色、描述和测试库成员。

查看示例数据

2.查看测试库成员

3.创建、更新和查看测试计划

您可以使用REST API创建测试计划、更新测试计划和获取测试计划。目前对外开放的测试计划属性包括:所属测试库、负责人、计划名、开始时间、结束时间和计划状态。

查看示例数据

4.查看测试用例

您可以使用REST API获取测试用例。目前对外开放的测试用例属性包括:所属测试库、所有者、用例标题、编号、级别、前置条件和测试步骤。

查看示例数据

5.创建、更新和查看运行用例

当一个测试用例被放入测试计划时,将自动生成一个运行用例,这个运行用例用于记录本次测试用例的执行结果。您可以使用REST API创建运行用例、更新运行用例和获取运行用例。目前对外开放的运行用例属性包括:所属测试库、所属测试计划、对应的测试用例、执行状态和执行步骤。

具体调用方式请参考PingCode REST API文档