You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

768 lines
21 KiB
YAML

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

definitions:
models.Response:
properties:
code:
type: integer
data: {}
msg:
type: string
type: object
info:
contact: {}
paths:
/api/device/v1/create:
post:
consumes:
- application/x-www-form-urlencoded
description: 新建设备,UDID唯一
parameters:
- description: 项目
in: formData
name: project
required: true
type: string
- description: 产品
in: formData
name: product_name
required: true
type: string
- description: 存放设备名字型号
in: formData
name: device_name
required: true
type: string
- description: 操作系统的版本
in: formData
name: os
type: string
- description: 设备唯一udid
in: formData
name: udid
required: true
type: string
- description: 操作系统平台adr/ios
in: formData
name: platform
required: true
type: string
responses:
"200":
description: 返回创建后的设备信息
schema:
$ref: '#/definitions/models.Response'
summary: 新建设备
tags:
- 设备相关 /api/device/v1/
/api/device/v1/delete/{id}:
delete:
consumes:
- application/x-www-form-urlencoded
description: 根据主键软删除设备is_del设为1
parameters:
- description: 设备id必传
in: path
name: id
required: true
type: string
responses:
"200":
description: 返回创建后的设备信息
schema:
$ref: '#/definitions/models.Response'
summary: 删除设备
tags:
- 设备相关 /api/device/v1/
/api/device/v1/get_device:
get:
consumes:
- application/x-www-form-urlencoded
description: 根据udid查询设备
parameters:
- description: 设备udid
in: query
name: udid
required: true
type: string
responses:
"200":
description: 返回设备信息
schema:
$ref: '#/definitions/models.Response'
summary: 查询设备
tags:
- 设备相关 /api/device/v1/
/api/device/v1/list:
get:
consumes:
- application/x-www-form-urlencoded
description: 获取设备列表
parameters:
- description: 每页大小,默认为10
in: query
name: page_size
type: integer
- description: 第几页,默认为第一页
in: query
name: page_index
type: integer
responses:
"200":
description: 返回设备列表信息
schema:
$ref: '#/definitions/models.Response'
summary: 获取设备列表
tags:
- 设备相关 /api/device/v1/
/api/device/v1/opt/install:
post:
consumes:
- application/x-www-form-urlencoded
description: 传入安装包链接并指定设备安装
parameters:
- description: 设备udid
in: formData
name: udid
required: true
type: string
- description: 安装平台
in: formData
name: pf
required: true
type: string
- description: 安装包下载链接
in: formData
name: pkg_url
required: true
type: string
responses:
"200":
description: 返回结果
schema:
$ref: '#/definitions/models.Response'
summary: 安装应用
tags:
- 设备相关 /api/device/v1/
/api/device/v1/update:
post:
consumes:
- application/x-www-form-urlencoded
description: 根据主键更新设备
parameters:
- description: 设备id必传
in: formData
name: id
required: true
type: string
- description: 项目
in: formData
name: project
type: string
- description: 产品
in: formData
name: product_name
type: string
- description: 存放设备名字型号
in: formData
name: device_name
type: string
- description: 操作系统的版本
in: formData
name: os
type: string
- description: 设备唯一udid
in: formData
name: udid
type: string
- description: 操作系统平台adr/ios
in: formData
name: platform
type: string
responses:
"200":
description: 返回创建后的设备信息
schema:
$ref: '#/definitions/models.Response'
summary: 更新设备
tags:
- 设备相关 /api/device/v1/
/api/device/v1/update_status:
post:
consumes:
- application/x-www-form-urlencoded
description: 更新设备状态,错误的状态会被拒绝
parameters:
- description: 设备udid
in: formData
name: udid
required: true
type: string
- description: 要更新的设备状态online-在线空闲busy-占用中offline-离线
in: formData
name: status
required: true
type: string
responses:
"200":
description: 返回更新的状态
schema:
$ref: '#/definitions/models.Response'
summary: 更新设备状态
tags:
- 设备相关 /api/device/v1/
/api/monkey/v1/create_task:
post:
consumes:
- application/x-www-form-urlencoded
description: 新建Monkey任务创建成功后将会发送指令到monkey服务初始status为WAITTING-等待中
parameters:
- description: 项目名
in: formData
name: project
type: string
- description: 测试包下载链接
in: formData
name: package_url
type: string
- description: 应用包名
in: formData
name: package_name
required: true
type: string
- description: 启动activity页
in: formData
name: launch_activity
type: string
- description: 平台adr/ios
in: formData
name: platform
required: true
type: string
- description: 运行时间s默认两小时7200s
in: formData
name: run_time
type: string
- description: 任务创建者
in: formData
name: creator
type: string
- description: 调用服务的方式0-cli模式/1-api模式默认cli
in: formData
name: mode
type: string
responses:
"200":
description: 返回创建的任务id
schema:
$ref: '#/definitions/models.Response'
summary: 新建Monkey任务
tags:
- Monkey相关 /api/monkey/v1/
/api/monkey/v1/devices:
get:
consumes:
- application/x-www-form-urlencoded
description: 获取安卓设备列表
parameters:
- description: 平台ios/adr
in: query
name: platform
type: integer
responses:
"200":
description: 返回设备信息
schema:
$ref: '#/definitions/models.Response'
summary: 获取设备列表
tags:
- Monkey相关 /api/monkey/v1/
/api/monkey/v1/task:
get:
consumes:
- application/x-www-form-urlencoded
description: 根据id获取monkey任务信息
parameters:
- description: 任务id
in: query
name: id
type: integer
responses:
"200":
description: 返回monkey任务信息
schema:
$ref: '#/definitions/models.Response'
summary: 获取monkey任务信息
tags:
- Monkey相关 /api/monkey/v1/
/api/monkey/v1/task/activity:
get:
consumes:
- application/x-www-form-urlencoded
description: 通过monkey任务id获取覆盖的活动页面
parameters:
- description: 任务id
in: query
name: task_id
required: true
type: integer
responses:
"200":
description: 返回任务覆盖的活动页
schema:
$ref: '#/definitions/models.Response'
summary: 获取覆盖页面列表
tags:
- Monkey相关 /api/monkey/v1/
post:
consumes:
- application/x-www-form-urlencoded
description: Android上报activity名
parameters:
- description: 任务id
in: formData
name: task_id
required: true
type: integer
- description: 设备id
in: formData
name: device_name
type: string
- description: 页面名称
in: formData
name: activity_name
type: string
responses:
"200":
description: 返回更新后的任务信息
schema:
$ref: '#/definitions/models.Response'
summary: 上报Monkey应用页
tags:
- Monkey相关 /api/monkey/v1/
/api/monkey/v1/task/crash_count:
post:
consumes:
- application/x-www-form-urlencoded
description: 更新Monkey任务崩溃数量
parameters:
- description: 任务id
in: formData
name: task_id
required: true
type: integer
- description: 要更新的崩溃数量
in: formData
name: crash_count
type: string
responses:
"200":
description: 返回更新后的任务信息
schema:
$ref: '#/definitions/models.Response'
summary: 更新Monkey任务崩溃数量
tags:
- Monkey相关 /api/monkey/v1/
/api/monkey/v1/task/devices:
get:
consumes:
- application/x-www-form-urlencoded
description: 获取安卓设备列表
parameters:
- description: 任务id
in: query
name: task_id
required: true
type: string
responses:
"200":
description: 返回设备信息
schema:
$ref: '#/definitions/models.Response'
summary: 获取设备列表
tags:
- Monkey相关 /api/monkey/v1/
/api/monkey/v1/task/pid:
post:
consumes:
- application/x-www-form-urlencoded
description: 上传进程id并关联到任务
parameters:
- description: 任务id
in: formData
name: task_id
required: true
type: integer
- description: 进程id
in: formData
name: pid
required: true
type: integer
responses:
"200":
description: 返回成功或失败
schema:
$ref: '#/definitions/models.Response'
summary: 上报进程id
tags:
- Monkey相关 /api/monkey/v1/
/api/monkey/v1/task/result:
get:
consumes:
- application/x-www-form-urlencoded
description: 通过任务id获取Monkey结果
parameters:
- description: 任务id
in: query
name: task_id
required: true
type: integer
responses:
"200":
description: 返回任务结果
schema:
$ref: '#/definitions/models.Response'
summary: 获取Monkey结果
tags:
- Monkey相关 /api/monkey/v1/
post:
consumes:
- application/x-www-form-urlencoded
description: 上报Monkey结果
parameters:
- description: 任务id
in: formData
name: task_id
required: true
type: integer
- description: 要更新的任务状态
in: formData
name: crash_log_list
type: string
- description: 要更新的任务状态
in: formData
name: activity_name_info
type: string
- description: 要更新的任务状态
in: formData
name: device_name
type: string
- description: 要更新的任务状态
in: formData
name: status
type: string
responses:
"200":
description: 返回更新后的任务信息
schema:
$ref: '#/definitions/models.Response'
summary: 上报Monkey结果
tags:
- Monkey相关 /api/monkey/v1/
/api/monkey/v1/task/status:
post:
consumes:
- application/x-www-form-urlencoded
description: 更新Monkey任务状态进行中为RUNNING已完成为FINISH如有错误为ERROR
parameters:
- description: 任务id
in: formData
name: task_id
required: true
type: integer
- description: 要更新的任务状态
in: formData
name: status
type: string
responses:
"200":
description: 返回更新后的任务信息
schema:
$ref: '#/definitions/models.Response'
summary: 更新Monkey任务状态
tags:
- Monkey相关 /api/monkey/v1/
/api/monkey/v1/task/stop:
post:
consumes:
- application/x-www-form-urlencoded
description: 停止monkey任务杀死所有关联任务的进程id
parameters:
- description: 任务id
in: formData
name: task_id
required: true
type: integer
responses:
"200":
description: 返回成功或失败
schema:
$ref: '#/definitions/models.Response'
summary: 停止monkey任务
tags:
- Monkey相关 /api/monkey/v1/
/api/monkey/v1/task/update_devices:
post:
consumes:
- application/x-www-form-urlencoded
description: 上报运行设备Udid调用后追加到指定任务的设备字段中
parameters:
- description: 任务id
in: formData
name: task_id
required: true
type: integer
- description: 设备udid
in: formData
name: udid
required: true
type: string
responses:
"200":
description: 返回成功或失败
schema:
$ref: '#/definitions/models.Response'
summary: 上报运行设备
tags:
- Monkey相关 /api/monkey/v1/
/api/monkey/v1/tasks:
get:
consumes:
- application/x-www-form-urlencoded
description: 获取任务列表
parameters:
- description: 每页大小,默认为10
in: query
name: page_size
type: integer
- description: 第几页,默认为第一页
in: query
name: page_index
type: integer
- description: 项目名称
in: query
name: project
type: integer
- description: 传1筛选有异常的任务
in: query
name: has_error
type: integer
responses:
"200":
description: 返回更新后的任务信息
schema:
$ref: '#/definitions/models.Response'
summary: 获取任务列表
tags:
- Monkey相关 /api/monkey/v1/
/api/monkey/v2/create_task:
post:
consumes:
- application/x-www-form-urlencoded
description: 新建Monkey任务创建成功后将会发送指令到monkey服务初始status为WAITTING-等待中
parameters:
- description: 项目名
in: formData
name: project
required: true
type: string
- description: 产品名
in: formData
name: product
required: true
type: string
- description: 应用包名
in: formData
name: package_name
required: true
type: string
- description: 测试包下载链接
in: formData
name: package_url
required: true
type: string
- description: 平台adr/ios
in: formData
name: platform
required: true
type: string
- description: 运行时间s默认两小时3600s
in: formData
name: run_time
type: string
- description: 安卓启动页名称
in: formData
name: launch_activity
type: string
- description: 任务创建者
in: formData
name: creator
type: string
- description: 启动来源web-平台启动ci-持续集成
in: formData
name: referer
type: string
- description: 调用服务的方式0-cli模式/1-api模式默认cli
in: formData
name: mode
type: string
- description: 备注
in: formData
name: remark
type: string
responses:
"200":
description: 返回创建的任务id
schema:
$ref: '#/definitions/models.Response'
summary: 新建Monkey任务
tags:
- Monkey相关 /api/monkey/v2/
/api/monkey/v2/task/command:
get:
consumes:
- application/x-www-form-urlencoded
description: 通过任务id获取任务的执行命令
parameters:
- description: 任务id
in: query
name: task_id
required: true
type: integer
responses:
"200":
description: 返回执行命令
schema:
$ref: '#/definitions/models.Response'
summary: 获取Monkey任务的执行命令
tags:
- Monkey相关 /api/monkey/v2/
/api/monkey/v2/task/get_anomalies:
get:
consumes:
- application/x-www-form-urlencoded
description: 通过任务id获取Monkey异常信息
parameters:
- description: 任务id
in: query
name: task_id
required: true
type: integer
responses:
"200":
description: 返回任务结果
schema:
$ref: '#/definitions/models.Response'
summary: 获取Monkey异常信息
tags:
- Monkey相关 /api/monkey/v2/
/api/monkey/v2/task/handle/set:
post:
consumes:
- application/x-www-form-urlencoded
description: 更新Monkey任务跟进状态
parameters:
- description: Monkey任务id
in: formData
name: task_id
required: true
type: string
- description: 跟进情况IN_PROGRESS-跟进中/DONE-已跟进
in: formData
name: handle_status
required: true
type: string
responses:
"200":
description: 返回创建后的设备信息
schema:
$ref: '#/definitions/models.Response'
summary: 更新任务跟进状态
tags:
- Monkey相关 /api/monkey/v2/
/api/monkey/v2/task/store_anomaly:
post:
consumes:
- application/x-www-form-urlencoded
description: 上报Monkey异常
parameters:
- description: 任务id
in: formData
name: task_id
required: true
type: integer
- description: 要更新的任务状态
in: formData
name: crash_log_list
type: string
- description: 要更新的任务状态
in: formData
name: activity_name_info
type: string
- description: 要更新的任务状态
in: formData
name: device_name
type: string
- description: 要更新的任务状态
in: formData
name: status
type: string
responses:
"200":
description: 返回更新后的任务信息
schema:
$ref: '#/definitions/models.Response'
summary: 上报Monkey异常
tags:
- Monkey相关 /api/monkey/v2/
/api/project/v1/app:
get:
consumes:
- application/x-www-form-urlencoded
description: 根据应用名称app_name获取应用信息
parameters:
- description: 应用名称
in: query
name: app_name
required: true
type: string
responses:
"200":
description: 返回任务结果
schema:
$ref: '#/definitions/models.Response'
summary: 获取应用信息
tags:
- Monkey相关 /api/project/v1/
/api/tool/v1/voice/list:
get:
consumes:
- application/x-www-form-urlencoded
description: 根据表单id获取声音评测内容返回分组和分组文件信息
parameters:
- description: 表单id
in: query
name: form_id
required: true
type: string
responses:
"200":
description: 返回分组和分组文件信息
schema:
$ref: '#/definitions/models.Response'
summary: 获取声音评测内容
tags:
- 工具相关 /api/tool/v1/
/webdav/monkey/task/:id/:filename:
put:
consumes:
- application/x-www-form-urlencoded
description: 上传Logcat日志
responses:
"200":
description: 返回成功或失败
schema:
$ref: '#/definitions/models.Response'
summary: 上传Logcat日志
tags:
- 文件相关 /webdav
swagger: "2.0"