报告接口

推送缺陷报告

• 接口路径: /api/report/defect

• 方法: POST

• 请求参数

{
    "handler": "demo",
    "reportTitle": "单元测试报告:com.cat2bug.junit.demo.Cat2BugRunnerTest",
    "reportTime": 1711546667143,
    "reportDescription": "报告描述",
    "reportData": [
        {
            "defectName": "[testRuleFalse(com.cat2bug.junit.demo.Cat2BugRunnerTest)]",
            "defectDescribe": "缺陷描述",
            "defectState": "PROCESSING",
            "defectType": "BUG",
            "defectLevel": "middle",
            "moduleVersion":"0.0.1",
            "groupKey": "com.cat2bug.junit.demo.Cat2BugRunnerTest",
            "key": "com.cat2bug.junit.demo.Cat2BugRunnerTest.testRuleFalse"
        }
    ]
}

请求参数说明：

参数	类型	范围	说明
handler	字符型	非必填，0至30个字节	处理人
reportTitle	字符型	必填，1至255个字节	报告标题
reportTime	长整型	必填	报告时间
reportDescription	字符型	必填，1至65536个字节	报告描述
reportData	JSON数组	非必填	缺陷数组

reportData数组中的格式属性说明：

参数	类型	范围	说明
defectName	字符型	必填，1至128个字节	缺陷名称
defectDescribe	字符型	必填，1至65536个字节	缺陷描述
defectState	字符型	非必填，默认PROCESSING；PROCESSING(待处理)、AUDIT(待审核)、REJECTED(已驳回)、CLOSED(已关闭)	缺陷状态
defectType	字符型	非必填，默认BUG；BUG(错误)、TASK(任务)、DEMAND(需求)	缺陷类型
defectLevel	字符型	非必填，默认MIDDLE；LOW(低)、MIDDLE(中)、HEIGHT(高)、URGENT(急)	缺陷级别
moduleVersion	字符型	非必填，1至128个字节	交付物的版本号
groupKey	字符型	非必填，1至255个字节	缺陷唯一关键组，通过此属性查找相同组的缺陷。如将某个类的类名作为groupKey，当测试后没有发现此类有问题，可通过这个groupKey属性来改变所有此类关联的缺陷状态。
key	字符型	非必填，1至255个字节	缺陷唯一关键字

• 返回值,code返回200代表推送成功。

{
    "msg":"操作成功",
    "code":200
}

• 示例

curl --location -X POST 'https://www.cat2bug.com:8022/prod-api/api/report/defect' \
-H 'Content-Type: application/json' \
-H 'CAT2BUG-API-KEY: 20240327001413he1mbyfi6fhnfets' \
-d '{"handler":"demo","reportTitle":"单元测试报告:com.cat2bug.junit.demo.Cat2BugRunnerTest","reportTime":1711546667143,"reportDescription":"报告描述","reportData":[{"defectName":"[testRuleFalse(com.cat2bug.junit.demo.Cat2BugRunnerTest)]","defectDescribe":"缺陷描述","defectState":"PROCESSING","defectType":"BUG","defectLevel":"middle","groupKey":"com.cat2bug.junit.demo.Cat2BugRunnerTest","key":"com.cat2bug.junit.demo.Cat2BugRunnerTest.testRuleFalse"}]}'

提示

请更换示例中的接口IP、端口和CAT2BUG-API-KEY密钥