API设计参考

风雪中的兔子
276 阅读5分钟

通用Response Object结构说明

参数名类型说明
codeNumber0 成功 -1失败
msgString辅助信息
dataBoolean、Object、String、Array响应数据

Class:Demand 需求类

const demand = new Demand()

模块相关操作方法

新增模块

demand.addModule(params)

Parameters Object
参数名类型是否必选默认值说明
idString否-新增模块不需要；新增子模块需要父级模块ID
nameString是-需求模块名称
Response Data
  • 返回对应添加状态
参数名类型说明
dataBoolean取值为：成功true、失败false
// 响应数据示例
{
    "code": 0,
    "msg": "success",
    "data": true
}

删除需求模块

demand.deleteModule(id)

Parameter String
参数名类型是否必选默认值说明
idString是-需求模块id
Response Data
  • 返回对应删除状态
参数名类型说明
dataBoolean取值为：成功true、失败false
// 响应数据示例
{
    "code": 0,
    "msg": "success",
    "data": true
}

编辑模块

demand.updateModule(params)

Parameters Object
参数名类型是否必选默认值说明
idString是-模块ID
nameString是-模块名称
Response Data
  • 返回对应编辑状态
参数名类型说明
dataBoolean取值为：成功true、失败false
// 响应数据示例
{
    "code": 0,
    "msg": "success",
    "data": true
}

获取模块列表

demand.getModuleList(params)

Response Data
参数名类型说明
dataArray数据列表
data数组中数据项说明
参数名类型说明
idString数据ID
nameString名称
keyString数据ID(方便Antd - Tree组件直接使用)
titleString名称(方便Antd - Tree组件直接使用)
createTimeString创建时间
demandNumsNumber需求数量
childrenArray子模块数组(Antd - Tree组件必须的属性)(数据格式同当前data数据)
// 响应数据示例
{
    "code": 0,
    "msg": "success",
    "data": [
        {
            "id": "MK-001",  // 具体根据后端返回
            "name": "test5",
            "key": "MK-001",
            "title": "test5",
            "createTime": "2024-05-20 15:56:33",
            "demandNums": 1,
            "children": [
                "id": "MK-0011",  // 具体根据后端返回
                "name": "ICD",
                "key": "MK-0011",
                "title": "ICD",
                "createTime": "2024-05-20 15:58:33",
                "demandNums": 1,
                "children": []
            ]
        },
        // ...
    ]
}

需求相关操作方法

新增需求

demand.add(params)

Parameters Object
参数名类型是否必选默认值说明
idString是-模块ID
nameString是-需求名称
descString是-需求描述
Response Data
  • 返回对应添加状态
参数名类型说明
dataBoolean取值为：成功true、失败false
// 响应数据示例
{
    "code": 0,
    "msg": "success",
    "data": true
}

删除需求

demand.delete(id)

Parameter String
参数名类型是否必选默认值说明
idString是-需求id
Response Data
  • 返回对应删除状态(成功true 失败false)
参数名类型说明
dataBoolean取值为：成功true、失败false
// 响应数据示例
{
    "code": 0,
    "msg": "success",
    "data": true
}

编辑需求

demand.update(params)

Parameters Object
参数名类型是否必选默认值说明
idString是-数据ID
nameString是-需求名称
descString是-需求描述
Response Data
  • 返回对应编辑状态
参数名类型说明
dataBoolean取值为：成功true、失败false
// 响应数据示例
{
    "code": 0,
    "msg": "success",
    "data": true
}

获取需求列表

demand.getList(params)

Parameters Object
  • 以下请求参数均为非必选项，默认值会在SDK进行处理
参数名类型是否必选默认值说明
idString否-模块ID
pageSizeNumber否10每页显示条数
currentNumber否1当前页
searchKeywordString否'' (空字符串)查询关键字(搜索框的值)
searchScopesString[string,...string[]]否['name']查询范围(非空),根据多个字段进行查询
sortDirectionString否desc排序方式(desc、asc)
sortColumnString否createTime排序字段
Response Object
参数名类型说明
totalNumber数据总数
listArray数据列表
  • list数组中数据项说明
参数名类型说明
idString数据ID
midString模块ID
nameString名称
updateTimeString更新时间
updaterString更新人
updaterNameString更新人姓名
createTimeString创建时间
casesNumsNumber关联用例数量
// 响应数据示例
{
    "code": 0,
    "msg": "success",
    "data": {
        "total": 5,
        "list": [
            {
                "id": "XQ-001", 
                "mid": "MK-0011", 
                "name": "通用Table组件开发", 
                "updateTime": "2024-05-22 16:04:22", 
                "updater": "BruceLee", 
                "createTime": "2024-05-20 13:04:22", 
                "casesNums": 5
            },
            // ...
        ]
    }
}

根据模块ID获取需求统计信息

demand.getStatisticsByModuleId(id)

Parameter String
参数名类型是否必选默认值说明
idString是-模块ID
Response Object
参数名类型说明
demandNumsNumber需求数
coverageRateNumber需求覆盖率
caseNumsNumber用例数
relatedNumsNumber关联用例次数
// 响应数据示例
{
    "code": 0,
    "msg": "success",
    "data": {
        "demandNums": 3163,
        "coverageRate": 90.71,
        "caseNums": 77,
        "relatedNums": 18
    }
}

获取需求详情

demand.getDetail(id)

Parameter String
参数名类型是否必选默认值说明
idString是-需求ID
Response Object
参数名类型说明
idString数据ID
midString模块ID
nameString名称
updateTimeString更新时间
updaterString更新人
updaterNameString更新人姓名
createTimeString创建时间
caseNumsNumber关联用例数
// 响应数据示例
{
    "code": 0,
    "msg": "success",
    "data": {
        "id": "XQ-001", 
        "mid": "MK-0011", 
        "name": "通用Table组件开发", 
        "updateTime": "2024-05-22 16:04:22", 
        "updater": "BruceLee", 
        "createTime": "2024-05-20 13:04:22", 
        "casesNums": 5
    }
}

获取需求关联用例列表

demand.getCaseList(params)

Parameters Object
参数名类型是否必选默认值说明
idString是-需求ID
Response Data
参数名类型说明
dataArray数据列表
  • data数组中数据项说明
参数名类型说明
idString数据ID
numberString编号
titleString标题
statusString状态
statusNameString状态中文描述
personNameString负责人姓名
priorityString优先级
// 响应数据示例
{
    "code": 0,
    "msg": "success",
    "data": [
        {
            "id": "YL-001", 
            "number": "ET-UPPER-001", // 格式根据产品具体确定
            "title": "前端通用SDK模拟数据接口", 
            "status": "develop", 
            "statusName": "开发", 
            "personName": "BruceLee", 
            "priority": "-" 
        },
        //...
    ]
}

关联用例

demand.relateCase(params)

Parameters Object
参数名类型是否必选默认值说明
didString是-需求id
casesIdsString[]是[]用例Id数组
Response Data
  • 返回对应关联状态
参数名类型说明
dataBoolean取值为：成功true、失败false
// 响应数据示例
{
    "code": 0,
    "msg": "success",
    "data": true
}

取消关联用例

demand.unrelateCase(params)

Parameters Object
参数名类型是否必选默认值说明
didString是-需求id
casesIdsString[]是[]用例Id数组
Response Data
  • 返回对应取消关联状态
参数名类型说明
dataBoolean取值为：成功true、失败false
// 响应数据示例
{
    "code": 0,
    "msg": "success",
    "data": true
}
avatar
文章
阅读
粉丝