[关闭]
@yiranblade 2019-12-28T08:28:52.000000Z 字数 12672 阅读 1353

缺陷管理系统后端接口文档

API文档

目录

用户身份码及bug状态码说明

字段 状态码 含义
role 1001 管理员
1002 开发人员
1003 测试人员
level 2001 缺陷紧急程度一般
2002 缺陷紧急程度紧急
2003 缺陷紧急程度十分紧急
finishedStatus 3001 待处理
3002 处理中
3003 处理完成

用户模块

添加用户

  1. POST /bugsystem/user HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/json
  4. Cache-Control: no-cache
  5. Postman-Token: 4ad6e128-1536-2585-c498-0066c913704e
  7. {
  8.     "userName":"04143160",
  9.     "userPassword":"04143160",
  10.     "role":0,
  11.     "name":"喵帕斯",
  12.     "department":"测试",
  13.     "email":"yiranblade@outlook.com"
  15. }
  1. {
  2.   "code": 200,
  3.   "data": "请求成功"
  4.  }

用户登录

  1. POST /bugsystem/login HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/x-www-form-urlencoded
  4. Cache-Control: no-cache
  5. Postman-Token: e37d5f47-fa93-d765-d037-2cca68d31445
  7. userName=04143160&password=04143160
  1. {
  2.     "code": 200,
  3.     "data": {
  4.         "userId": "1",
  5.         "name": "喵帕斯",
  6.         "department": "测试",
  7.         "createTime": "2018-04-12 16:23:31.0",
  8.         "userName": "04143155",
  9.         "email": "yiranblade@outlook.com"
  10.     }
  11. }

获取所有用户信息

  1. GET /bugsystem/user HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/x-www-form-urlencoded
  4. Cache-Control: no-cache
  5. Postman-Token: ba195a6a-a4e3-c90f-5608-24494ca7b7f6
  1. {
  2.     "code": 200,
  3.     "data": [
  4.         {
  5.             "userId": "1",
  6.             "name": "喵帕斯",
  7.             "department": "测试",
  8.             "createTime": 1522067207000,
  9.             "userName": "04143160",
  10.             "email": "yiranblade@outlook.com"
  11.         }
  12.     ]
  13. }

删除用户账户

  1. DELETE /bugsystem/user/04143160 HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/x-www-form-urlencoded
  4. Cache-Control: no-cache
  5. Postman-Token: 0c0d1d5e-3139-ca05-7fba-c2db4a11df0e
  7. userName=04143160&password=04143160
  1. {
  2.     "code": 200,
  3.     "data": "删除成功"
  4. }

文档模块

上传新文档

  1. POST /bugsystem/upload HTTP/1.1
  2. Host: localhost:8080
  3. Cache-Control: no-cache
  4. Postman-Token: c03df840-586e-ba78-55d3-70884567561c
  5. Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
  7. ------WebKitFormBoundary7MA4YWxkTrZu0gW
  8. Content-Disposition: form-data; name="projectId"
  10. 1
  11. ------WebKitFormBoundary7MA4YWxkTrZu0gW
  12. Content-Disposition: form-data; name="files"; filename="2017-01-15 19-17-49 的屏幕截图.png"
  13. Content-Type: image/png
  16. ------WebKitFormBoundary7MA4YWxkTrZu0gW
  17. Content-Disposition: form-data; name="files"; filename="2017-01-15 19-18-14 的屏幕截图.png"
  18. Content-Type: image/png
  21. ------WebKitFormBoundary7MA4YWxkTrZu0gW--
  1. {
  2.     "code": 200,
  3.     "data": "上传成功"
  4. }

下载文档

  1. POST /bugsystem/download HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/x-www-form-urlencoded
  4. Cache-Control: no-cache
  5. Postman-Token: a2d7f4a9-f244-c886-0895-7cc43819af0b
  7. fileName=image&filePath=%2Fhome%2Fyiranblade%2Fworkspace%2F.metadata%2F.plugins%2Forg.eclipse.wst.server.core%2Ftmp1%2Fwtpwebapps%2Fbugsystem%2FWEB-INF%2Fclasses%2F2017-01-15+19-18-14+%E7%9A%84%E5%B1%8F%E5%B9%95%E6%88%AA%E5%9B%BE.png
  1. 自动开始下载文件

获取所有文档信息

  1. GET /bugsystem/document HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/x-www-form-urlencoded
  4. Cache-Control: no-cache
  5. Postman-Token: 9f2a073a-7bbf-8640-2056-f6b9e4c9e3c4
  1. {
  2.     "code": 200,
  3.     "data": [
  4.         {
  5.             "documId": 3,
  6.             "documUrl": "/home/yiranblade/workspace/.metadata/.plugins/org.eclipse.wst.server.core/tmp1/wtpwebapps/bugsystem/WEB-INF/classes/2017-01-15 19-17-49 的屏幕截图.png",
  7.             "documType": "image/png",
  8.             "projectId": 1,
  9.             "createTime": 1522124853000
  10.         },
  11.         {
  12.             "documId": 4,
  13.             "documUrl": "/home/yiranblade/workspace/.metadata/.plugins/org.eclipse.wst.server.core/tmp1/wtpwebapps/bugsystem/WEB-INF/classes/2017-01-15 19-18-14 的屏幕截图.png",
  14.             "documType": "image/png",
  15.             "projectId": 1,
  16.             "createTime": 1522124853000
  17.         }
  18.     ]
  19. }

通过项目ID获取文档

  1. GET /bugsystem/document/1 HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/x-www-form-urlencoded
  4. Cache-Control: no-cache
  5. Postman-Token: efa8cb28-c379-5a6c-fa5b-7088b2086736
  1. {
  2.     "code": 200,
  3.     "data": [
  4.         {
  5.             "documId": 3,
  6.             "documUrl": "/home/yiranblade/workspace/.metadata/.plugins/org.eclipse.wst.server.core/tmp1/wtpwebapps/bugsystem/WEB-INF/classes/2017-01-15 19-17-49 的屏幕截图.png",
  7.             "documType": "image/png",
  8.             "projectId": 1,
  9.             "createTime": 1522124853000
  10.         },
  11.         {
  12.             "documId": 4,
  13.             "documUrl": "/home/yiranblade/workspace/.metadata/.plugins/org.eclipse.wst.server.core/tmp1/wtpwebapps/bugsystem/WEB-INF/classes/2017-01-15 19-18-14 的屏幕截图.png",
  14.             "documType": "image/png",
  15.             "projectId": 1,
  16.             "createTime": 1522124853000
  17.         }
  18.     ]
  19. }

项目模块

增加新项目

  1. POST /bugsystem/project HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/json
  4. Cache-Control: no-cache
  5. Postman-Token: 22349018-c5aa-2781-88a6-d4a73e54e097
  7. {
  8.     "name":"bug系统",
  9.     "createUser":"04143160",
  10.     "type":"管理",
  11.     "descr":"这是一个测试"
  12. }
  1. {
  2.     "code": 200,
  3.     "data": "插入成功"
  4. }

删除项目

  1. DELETE /bugsystem/project/1 HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
  4. Cache-Control: no-cache
  5. Postman-Token: ec73b46f-defd-d044-a4b9-b556eedc1727
  1. {
  2.     "code": 200,
  3.     "data": "删除成功"
  4. }

修改项目

  1. PUT /bugsystem/project HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/json
  4. Cache-Control: no-cache
  5. Postman-Token: c7e3f9fc-d7ff-c5c0-3dae-596fea1d2f21
  7. {
  8.     "projectId":1,
  9.     "name":"喵帕斯系统",
  10.     "createUser":"04143160",
  11.     "type":"管理",
  12.     "descr":"这是一个测试"
  13. }
  1. {
  2.     "code": 200,
  3.     "data": "更新成功"
  4. }

获取所有的项目

  1. GET /bugsystem/project HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/json
  4. Cache-Control: no-cache
  5. Postman-Token: 74decbb0-01b4-f320-f2f1-3ff6196880b7
  1. {
  2.     "code": 200,
  3.     "data": [
  4.         {
  5.             "projectId": 2,
  6.             "name": "bug系统",
  7.             "createUser": "04143160",
  8.             "type": "管理",
  9.             "documentId": -1,
  10.             "createTime": 1522138261000,
  11.             "descr": "这是一个测试"
  12.         },
  13.         {
  14.             "projectId": 3,
  15.             "name": "bug系统",
  16.             "createUser": "04143160",
  17.             "type": "管理",
  18.             "documentId": -1,
  19.             "createTime": 1522138262000,
  20.             "descr": "这是一个测试"
  21.         },
  22.         {
  23.             "projectId": 4,
  24.             "name": "bug系统",
  25.             "createUser": "04143160",
  26.             "type": "管理",
  27.             "documentId": -1,
  28.             "createTime": 1522138262000,
  29.             "descr": "这是一个测试"
  30.         },
  31.         {
  32.             "projectId": 5,
  33.             "name": "bug系统",
  34.             "createUser": "04143160",
  35.             "type": "管理",
  36.             "documentId": -1,
  37.             "createTime": 1522138262000,
  38.             "descr": "这是一个测试"
  39.         },
  40.         {
  41.             "projectId": 6,
  42.             "name": "bug系统",
  43.             "createUser": "04143160",
  44.             "type": "管理",
  45.             "documentId": -1,
  46.             "createTime": 1522138262000,
  47.             "descr": "这是一个测试"
  48.         },
  49.         {
  50.             "projectId": 7,
  51.             "name": "bug系统",
  52.             "createUser": "04143160",
  53.             "type": "管理",
  54.             "documentId": -1,
  55.             "createTime": 1522138263000,
  56.             "descr": "这是一个测试"
  57.         }
  58.     ]
  59. }

获取项目根据用户名

  1. GET /bugsystem/project/04143160 HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/json
  4. Cache-Control: no-cache
  5. Postman-Token: a40c75b2-c471-30a4-d14f-b27ee126b406
  1. {
  2.     "code": 200,
  3.     "data": [
  4.         {
  5.             "projectId": 2,
  6.             "name": "bug系统",
  7.             "createUser": "04143160",
  8.             "type": "管理",
  9.             "documentId": -1,
  10.             "createTime": 1522138261000,
  11.             "descr": "这是一个测试"
  12.         },
  13.         {
  14.             "projectId": 3,
  15.             "name": "bug系统",
  16.             "createUser": "04143160",
  17.             "type": "管理",
  18.             "documentId": -1,
  19.             "createTime": 1522138262000,
  20.             "descr": "这是一个测试"
  21.         },
  22.         {
  23.             "projectId": 4,
  24.             "name": "bug系统",
  25.             "createUser": "04143160",
  26.             "type": "管理",
  27.             "documentId": -1,
  28.             "createTime": 1522138262000,
  29.             "descr": "这是一个测试"
  30.         },
  31.         {
  32.             "projectId": 5,
  33.             "name": "bug系统",
  34.             "createUser": "04143160",
  35.             "type": "管理",
  36.             "documentId": -1,
  37.             "createTime": 1522138262000,
  38.             "descr": "这是一个测试"
  39.         },
  40.         {
  41.             "projectId": 6,
  42.             "name": "bug系统",
  43.             "createUser": "04143160",
  44.             "type": "管理",
  45.             "documentId": -1,
  46.             "createTime": 1522138262000,
  47.             "descr": "这是一个测试"
  48.         },
  49.         {
  50.             "projectId": 7,
  51.             "name": "bug系统",
  52.             "createUser": "04143160",
  53.             "type": "管理",
  54.             "documentId": -1,
  55.             "createTime": 1522138263000,
  56.             "descr": "这是一个测试"
  57.         }
  58.     ]
  59. }

缺陷模块

增添新缺陷

  1. POST /bugsystem/bug HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/json
  4. Cache-Control: no-cache
  5. Postman-Token: aaa84e8b-1e7b-cc29-5454-7c0797dc61ca
  7. {
  8.     "bugName":"无法访问",
  9.     "detail":"推测是编码",
  10.     "projectId":2,
  11.     "level":2,
  12.     "finishedStatus":3
  13. }
  1. {
  2.     "code": 200,
  3.     "data": "增加成功"
  4. }

更新缺陷

  1. PUT /bugsystem/bug HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/json
  4. Cache-Control: no-cache
  5. Postman-Token: d0493650-b14a-1586-2158-5ea910e8d32e
  7. {
  8.     "bugId":1,
  9.     "bugName":"修改完毕",
  10.     "detail":"推测是编码",
  11.     "projectId":2,
  12.     "level":2,
  13.     "finishedStatus":3
  14. }
  1. {
  2.     "code": 200,
  3.     "data": "请求成功"
  4. }

获取所有缺陷

  1. GET /bugsystem/bug HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/json
  4. Cache-Control: no-cache
  5. Postman-Token: 3dde4ed9-fcfe-f60a-afad-f01be202105e
  1. {
  2.     "code": 200,
  3.     "data": [
  4.         {
  5.             "bugId": 1,
  6.             "bugName": "修改完毕",
  7.             "detail": "推测是编码",
  8.             "projectId": 2,
  9.             "level": 2,
  10.             "finishedStatus": 3,
  11.             "createTime": 1522141837000
  12.         }
  13.     ]
  14. }

分配缺陷给用户

  1. GET /bugsystem/bug/arrange/1&1 HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/json
  4. Cache-Control: no-cache
  5. Postman-Token: e9c7eefe-03d9-9db0-b553-97730a132aae
  1. {
  2.     "code": 200,
  3.     "data": "请求成功"
  4. }

获取缺陷通过用户ID

  1. GET /bugsystem/bug/user/1 HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/json
  4. Cache-Control: no-cache
  5. Postman-Token: 7c87b73a-7733-fb72-08ba-26c88c49069d
  1. {
  2.     "code": 200,
  3.     "data": [
  4.         {
  5.             "bugId": 1,
  6.             "bugName": "修改完毕",
  7.             "detail": "推测是编码",
  8.             "projectId": 2,
  9.             "level": 2,
  10.             "finishedStatus": 3,
  11.             "createTime": 1522141837000
  12.         }
  13.     ]
  14. }

获取缺陷通过项目ID

  1. GET /bugsystem/bug/project/2 HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/json
  4. Cache-Control: no-cache
  5. Postman-Token: 41826d1f-0b06-7159-833f-d5b3a0a43bcd
  1. {
  2.     "code": 200,
  3.     "data": [
  4.         {
  5.             "bugId": 1,
  6.             "bugName": "修改完毕",
  7.             "detail": "推测是编码",
  8.             "projectId": 2,
  9.             "level": 2,
  10.             "finishedStatus": 3,
  11.             "createTime": 1522141837000
  12.         }
  13.     ]
  14. }

获取所有缺陷分配情况

  1. GET /bugsystem/bug/arrange/all HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/x-www-form-urlencoded
  4. Cache-Control: no-cache
  5. Postman-Token: 2af26002-6593-f52c-877f-1aea9c652b40
  1. {
  2.     "code": 200,
  3.     "data": [
  4.         {
  5.             "bugUserid": 1,
  6.             "bugId": 1,
  7.             "userId": 1,
  8.             "createTime": "2018-03-27 17:45:06.0"
  9.         }
  10.     ]
  11. }
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注