OpenSTF API讲解

时间:2024-04-02 18:16:36

一、前言

凡是做过移动端测试的同学,相信对OpenSTF都不陌生,该项目来自Github开源项目(看源码)。

在搭建自己的测试平台时,会利用STF的API进行设备远程占用、释放,以及获取设备信息,本文即为大家讲解STF的API,其实很简单。

OpenSTF平台界面,如下图:

(1)设备列表页

OpenSTF API讲解

(2)设备远程会话页

OpenSTF API讲解

二、生成令牌

前提:在整个接口调用过程中,都需要访问令牌,所以需先生成令牌。

OpenSTF API讲解

说明:在web页面生成访问令牌,该令牌包含在每个请求中

三、OpenSTF常用接口

1、获取用户信息

Method: GET

URL: http://stf.zxtest.com/api/v1/user

Header:

Authorization: Bearer d934206703ce456db5c45fa84b5fe1783354a552876744cb8f0a3bd913fdb68f

2、列出所有STF设备(包括断开连接或其他无法访问的设备)

Method: GET

URL: http://stf.zxtest.com/api/v1/devices

Header: Authorization: Bearer d934206703ce456db5c45fa84b5fe1783354a552876744cb8f0a3bd913fdb68f

3、返回有关特定设备的信息

Method:GET

URL:http://stf.zxtest.com/api/v1/devices/FA6990313540

Header: Authorization: Bearer d934206703ce456db5c45fa84b5fe1783354a552876744cb8f0a3bd913fdb68f

4、返回有关您自己(经过身份验证的用户)的信息

Method:GET

URL:http://stf.zxtest.com//api/v1/user

Header: Authorization: Bearer d934206703ce456db5c45fa84b5fe1783354a552876744cb8f0a3bd913fdb68f

5、返回经过身份验证的用户当前正在使用的设备的列表

Method:GET

URL:http://stf.zxtest.com/api/v1/user/devices

Header: Authorization: Bearer d934206703ce456db5c45fa84b5fe1783354a552876744cb8f0a3bd913fdb68f

6、尝试在经过身份验证的用户控制下添加设备。 这类似于在UI中按下“使用”

Method:POST

URL:http://stf.zxtest.com/api/v1/user/devices

Header:

(1)Authorization: Bearer d934206703ce456db5c45fa84b5fe1783354a552876744cb8f0a3bd913fdb68f

(2)Content-Type:application/json

Body:{"serial":"FA6990313540”}

7、从经过身份验证的用户的设备列表中删除设备。 这类似于在UI中按下“停止使用”

Method:DELETE

URL:http://stf.zxtest.com/api/v1/user/devices/FA6990313540

Header:Authorization: Bearer d934206703ce456db5c45fa84b5fe1783354a552876744cb8f0a3bd913fdb68f

8、获取设备远程连接url

Method:POST

URL:http://stf.zxtest.com/api/v1/user/devices/FA6990313540/remoteConnect

Header:Authorization: Bearer d934206703ce456db5c45fa84b5fe1783354a552876744cb8f0a3bd913fdb68f

9、断开设备远程调试会话

Method:DELETE

URL:http://stf.zxtest.com/api/v1/user/devices/FA6990313540/remoteConnect

Header:Authorization: Bearer d934206703ce456db5c45fa84b5fe1783354a552876744cb8f0a3bd913fdb68f

四、远程使用设备接口顺序

远程请求设备的顺序:

(1)添加设备(使用):6

(2)获取远程调试URL:8

(3)断开设备远程调试会话:9

(4)设备列表中删除设备(停止使用):7