[关闭]
@yiranblade 2017-05-02T12:44:00.000000Z 字数 25311 阅读 334

实验室管理系统接口文档

API文档

目录

缩写单词说明

缩写 说明
lbms [laboratory manage system]实验室管理系统
admin [administrator]管理员
tea [teacher]老师
num [number]学生ID

管理员相关接口

学生模块

增添学生

  1.  POST /lbms/student HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/json
  4. Cache-Control: no-cache
  5. Postman-Token: 17a970cf-7e0d-cfc3-8e1e-b3d73e833569
  7. {
  8.     "name":"李璠涛",
  9.     "sex":"0",
  10.     "specialization":"软件",
  11.     "grade":"2014",
  12.     "contact":"15667027637"
  13. }
  1. {
  2.   "code": 200,
  3.   "object": "Zf7WV7XH"//登录账户名(很重要)
  4. }

删除学生

  1. {
  2.   "code": 200,
  3.   "data": "删除成功"
  4. }

修改学生

  1. {
  2.   "code": 200,
  3.   "data": "更新成功"
  4. }

获取全部学生信息

  1. {
  2.   "code": 200,
  3.   "data": {
  4.     "currentPage": 1,
  5.     "pageSize": 8,
  6.     "recordCount": 1,
  7.     "recordList": [
  8.       {
  9.         "numid": 4,
  10.         "name": "喵帕斯",
  11.         "sex": "1",
  12.         "specialization": "软件",
  13.         "grade": "2014",
  14.         "date": null,
  15.         "contact": "15667027637"
  16.       }
  17.     ],
  18.     "pageCount": 1,
  19.     "beginPageIndex": 1,
  20.     "endPageIndex": 1
  21.   }
  22. }

获取预约项目的学生

  1. GET /lbms/student/1/1 HTTP/1.1
  2. Host: localhost:8080
  3. Cache-Control: no-cache
  4. Postman-Token: f0805281-947b-517d-644d-f1a794d5f5f7
  1. {
  2.   "code": 200,
  3.   "data": {
  4.     "currentPage": 1,
  5.     "pageSize": 8,
  6.     "recordCount": 10,
  7.     "recordList": [
  8.       {
  9.         "numid": 4,
  10.         "name": "喵帕斯",
  11.         "sex": "1",
  12.         "specialization": "软件1405",
  13.         "grade": "2014",
  14.         "date": "2017-02-12 11:16:59.0",
  15.         "contact": "15667027637"
  16.       }
  17.     ],
  18.     "pageCount": 2,
  19.     "beginPageIndex": 1,
  20.     "endPageIndex": 2
  21.   }
  22. }

通过年级查找学生

  1. GET /lbms/student/page/grade/2014&1 HTTP/1.1
  2. Host: localhost:8080
  3. Cache-Control: no-cache
  4. Postman-Token: 6da8369c-bd5a-4d05-9ec9-c8a5388affa0
  1. {
  2.   "code": 200,
  3.   "data": {
  4.     "currentPage": 1,
  5.     "pageSize": 8,
  6.     "recordCount": 10,
  7.     "recordList": [
  8.       {
  9.         "numid": 4,
  10.         "name": "喵帕斯",
  11.         "sex": "1",
  12.         "specialization": "软件1405",
  13.         "grade": "2014",
  14.         "date": "2017-02-12 11:16:59.0",
  15.         "contact": "15667027637"
  16.       },
  17.       {
  18.         "numid": 5,
  19.         "name": "李璠涛",
  20.         "sex": "1",
  21.         "specialization": "软件1405",
  22.         "grade": "2014",
  23.         "date": "2017-02-14 16:46:01.0",
  24.         "contact": "15667027637"
  25.       },
  26.       {
  27.         "numid": 6,
  28.         "name": "李璠涛",
  29.         "sex": "1",
  30.         "specialization": "软件1405",
  31.         "grade": "2014",
  32.         "date": "2017-02-14 16:46:06.0",
  33.         "contact": "15667027637"
  34.       },
  35.       {
  36.         "numid": 7,
  37.         "name": "李璠涛",
  38.         "sex": "1",
  39.         "specialization": "软件1405",
  40.         "grade": "2014",
  41.         "date": "2017-02-14 16:46:08.0",
  42.         "contact": "15667027637"
  43.       },
  44.       {
  45.         "numid": 8,
  46.         "name": "李璠涛",
  47.         "sex": "1",
  48.         "specialization": "软件1405",
  49.         "grade": "2014",
  50.         "date": "2017-02-14 16:46:09.0",
  51.         "contact": "15667027637"
  52.       },
  53.       {
  54.         "numid": 9,
  55.         "name": "李璠涛",
  56.         "sex": "1",
  57.         "specialization": "软件1405",
  58.         "grade": "2014",
  59.         "date": "2017-02-14 16:46:10.0",
  60.         "contact": "15667027637"
  61.       },
  62.       {
  63.         "numid": 10,
  64.         "name": "李璠涛",
  65.         "sex": "1",
  66.         "specialization": "软件1405",
  67.         "grade": "2014",
  68.         "date": "2017-02-14 16:46:11.0",
  69.         "contact": "15667027637"
  70.       },
  71.       {
  72.         "numid": 11,
  73.         "name": "李璠涛",
  74.         "sex": "1",
  75.         "specialization": "软件1405",
  76.         "grade": "2014",
  77.         "date": "2017-02-14 16:46:11.0",
  78.         "contact": "15667027637"
  79.       }
  80.     ],
  81.     "pageCount": 2,
  82.     "beginPageIndex": 1,
  83.     "endPageIndex": 2
  84.   }
  85. }

通过专业查找学生

  1. GET /lbms/student/page/special/软件1405&1 HTTP/1.1
  2. Host: localhost:8080
  3. Cache-Control: no-cache
  4. Postman-Token: 7544bb08-1ed6-49d2-ce91-ade69d1004d6
  1. {
  2.   "code": 200,
  3.   "data": {
  4.     "currentPage": 1,
  5.     "pageSize": 8,
  6.     "recordCount": 10,
  7.     "recordList": [
  8.       {
  9.         "numid": 4,
  10.         "name": "喵帕斯",
  11.         "sex": "1",
  12.         "specialization": "软件1405",
  13.         "grade": "2014",
  14.         "date": "2017-02-12 11:16:59.0",
  15.         "contact": "15667027637"
  16.       },
  17.       {
  18.         "numid": 5,
  19.         "name": "李璠涛",
  20.         "sex": "1",
  21.         "specialization": "软件1405",
  22.         "grade": "2014",
  23.         "date": "2017-02-14 16:46:01.0",
  24.         "contact": "15667027637"
  25.       },
  26.       {
  27.         "numid": 6,
  28.         "name": "李璠涛",
  29.         "sex": "1",
  30.         "specialization": "软件1405",
  31.         "grade": "2014",
  32.         "date": "2017-02-14 16:46:06.0",
  33.         "contact": "15667027637"
  34.       },
  35.       {
  36.         "numid": 7,
  37.         "name": "李璠涛",
  38.         "sex": "1",
  39.         "specialization": "软件1405",
  40.         "grade": "2014",
  41.         "date": "2017-02-14 16:46:08.0",
  42.         "contact": "15667027637"
  43.       },
  44.       {
  45.         "numid": 8,
  46.         "name": "李璠涛",
  47.         "sex": "1",
  48.         "specialization": "软件1405",
  49.         "grade": "2014",
  50.         "date": "2017-02-14 16:46:09.0",
  51.         "contact": "15667027637"
  52.       },
  53.       {
  54.         "numid": 9,
  55.         "name": "李璠涛",
  56.         "sex": "1",
  57.         "specialization": "软件1405",
  58.         "grade": "2014",
  59.         "date": "2017-02-14 16:46:10.0",
  60.         "contact": "15667027637"
  61.       },
  62.       {
  63.         "numid": 10,
  64.         "name": "李璠涛",
  65.         "sex": "1",
  66.         "specialization": "软件1405",
  67.         "grade": "2014",
  68.         "date": "2017-02-14 16:46:11.0",
  69.         "contact": "15667027637"
  70.       },
  71.       {
  72.         "numid": 11,
  73.         "name": "李璠涛",
  74.         "sex": "1",
  75.         "specialization": "软件1405",
  76.         "grade": "2014",
  77.         "date": "2017-02-14 16:46:11.0",
  78.         "contact": "15667027637"
  79.       }
  80.     ],
  81.     "pageCount": 2,
  82.     "beginPageIndex": 1,
  83.     "endPageIndex": 2
  84.   }
  85. }

教师模块

增加教师

  1. {
  2.   "code": 200,
  3.   "data": "MTIc1pFF"//登录名很重要
  4. }

更新教师

  1. PUT /lbms/teacher HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/json
  4. Cache-Control: no-cache
  5. Postman-Token: 49f0b3af-83d6-66f3-0f5f-45f460027f00
  7. {
  8.     "teaid":1,
  9.     "name":"喵帕斯",
  10.     "sex":"0",
  11.     "title":"软件",
  12.     "education":"硕士",
  13.     "contact":"15667027637"
  14. }
  1. {
  2.   "code": 200,
  3.   "data": "更新成功"
  4. }

删除教师

  1. DELETE /lbms/teacher/2 HTTP/1.1
  2. Host: localhost:8080
  3. Cache-Control: no-cache
  4. Postman-Token: ede04d9a-f955-b7a8-420e-500c0c365a0f
  5. Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
  7. ------WebKitFormBoundary7MA4YWxkTrZu0gW--
  1. {
  2.   "code": 200,
  3.   "data": "删除成功"
  4. }

获取教师信息

  1. {
  2.   "code": 200,
  3.   "data": "删除成功"
  4. }

获取教师信息

  1.     {
  2.   "code": 200,
  3.   "data": {
  4.     "teaid": 1,
  5.     "name": "喵帕斯",
  6.     "sex": "0",
  7.     "title": "软件",
  8.     "education": "硕士",
  9.     "date": null,
  10.     "contact": "15667027637"
  11.   }
  12. }

项目模块

增加项目

  1. {
  2.   "code": 200,
  3.   "data": "创建成功"
  4. }

更新项目

  1. {
  2.   "code": 200,
  3.   "data": "更新成功"
  4. }

删除项目信息

  1. {
  2.   "code": 200,
  3.   "data": "删除成功"
  4. }

通过ID获取项目

  1. {
  2.   "code": 200,
  3.   "data": {
  4.     "itemid": 1,
  5.     "itemname": "排序算法练习",
  6.     "term": "第二学期",
  7.     "coursename": "数据结构与算法"
  8.   }
  9. }

获取项目信息

  1. {
  2.   "code": 200,
  3.   "data": {
  4.     "currentPage": 1,
  5.     "pageSize": 8,
  6.     "recordCount": 1,
  7.     "recordList": [
  8.       {
  9.         "itemid": 1,
  10.         "itemname": "排序算法练习",
  11.         "term": "第二学期",
  12.         "coursename": "数据结构与算法"
  13.       }
  14.     ],
  15.     "pageCount": 1,
  16.     "beginPageIndex": 1,
  17.     "endPageIndex": 1
  18.   }
  19. }

项目批次模块

增加项目批次

  1. POST /lbms/batch HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/json
  4. Cache-Control: no-cache
  5. Postman-Token: fdc34ca7-ec3d-1207-a966-c51976f04bfa
  7. {
  8.     "itemid":1,
  9.     "teaid":1,
  10.     "laboratory":"FF104",
  11.     "date":"2017-02-12",
  12.     "segmentation":"3,4节"
  13. }
  1. {
  2.   "code": 200,
  3.   "data": "创建成功"
  4. }

更新项目批次

  1. PUT /lbms/batch HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/json
  4. Cache-Control: no-cache
  5. Postman-Token: 8b3fd6b1-54c3-785a-1ac7-5d7d95b815d7
  7. {
  8.     "batid":1,
  9.     "itemid":1,
  10.     "teaid":1,
  11.     "laboratory":"FF104",
  12.     "date":"2017-02-12",
  13.     "segmentation":"5,6节"
  14. }
  1. {
  2.   "code": 200,
  3.   "data": "更新成功"
  4. }

删除项目批次

  1. {
  2.   "code": 200,
  3.   "data": "删除成功"
  4. }

获取项目批次通过ID

  1. {
  2.   "code": 200,
  3.   "data": {
  4.     "batid": 1,
  5.     "itemid": 1,
  6.     "teaid": 1,
  7.     "laboratory": "FF104",
  8.     "date": "2017-02-12",
  9.     "segmentation": "5,6节",
  10.     "sure": null
  11.   }
  12. }

获取项目批次信息

  1. {
  2.   "code": 200,
  3.   "data": {
  4.     "currentPage": 1,
  5.     "pageSize": 8,
  6.     "recordCount": 1,
  7.     "recordList": [
  8.       {
  9.         "batid": 1,
  10.         "itemid": 1,
  11.         "teaid": 1,
  12.         "laboratory": "FF104",
  13.         "date": "2017-02-12",
  14.         "segmentation": "5,6节",
  15.         "sure": null
  16.       }
  17.     ],
  18.     "pageCount": 1,
  19.     "beginPageIndex": 1,
  20.     "endPageIndex": 1
  21.   }
  22. }

管理员账户模块

增加管理员

  1. {
  2.   "code": 200,
  3.   "data": "WID0JGxL"//登录账号 很重要
  4. }

更新管理员

{
"admid":"1",
"name":"喵帕斯",
"sex":"1",
"contact":"15667027637"
}
```

  1. {
  2.   "code": 200,
  3.   "data": "更新成功"
  4. }

删除管理员

  1. {
  2.   "code": 200,
  3.   "data": "删除成功"
  4. }

获取所有管理员

  1. GET /lbms/administrator/page/1 HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/x-www-form-urlencoded
  4. Cache-Control: no-cache
  5. Postman-Token: 5b553074-7ba0-3743-ff4e-6dc96902958b
  1. {
  2.   "code": 200,
  3.   "data": {
  4.     "currentPage": 1,
  5.     "pageSize": 8,
  6.     "recordCount": 1,
  7.     "recordList": [
  8.       {
  9.         "admid": 1,
  10.         "itemid": null,
  11.         "name": "喵帕斯",
  12.         "sex": "1",
  13.         "contact": "15667027637"
  14.       }
  15.     ],
  16.     "pageCount": 1,
  17.     "beginPageIndex": 1,
  18.     "endPageIndex": 1
  19.   }
  20. }

获取相关管理员

  1. GET /lbms/administrator/1 HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/x-www-form-urlencoded
  4. Cache-Control: no-cache
  5. Postman-Token: db4811d3-6c1c-7d25-a942-86a5e7402054
  1. {
  2.   "code": 200,
  3.   "data": {
  4.     "admid": 1,
  5.     "itemid": null,
  6.     "name": "喵帕斯",
  7.     "sex": "1",
  8.     "contact": "15667027637"
  9.   }
  10. }

修改相关管理员密码

  1. {
  2.   "code": 500,
  3.   "data": "更新失败"
  4. }

公告栏模块

增加公告栏

  1. POST /lbms/notice HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/json
  4. Cache-Control: no-cache
  5. Postman-Token: b8f7617d-81ba-34c1-5e2b-291a6b2df1b2
  7. {
  8.     "noticetile":"先关于实验取消",
  9.     "noticecontent":"今天下午所有实验课取消"
  10. }
  1. {
  2.   "code": 200,
  3.   "data": "添加成功"
  4. }

更新公告栏

  1. PUT /lbms/notice HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/json
  4. Cache-Control: no-cache
  5. Postman-Token: 99c86328-c50d-3a42-0cad-5c780e839b8c
  7. {
  8.     "noticeid":"1",
  9.     "noticetile":"通知",
  10.     "noticecontent":"今天下午所有实验课取消"
  11. }

start=A&end=B

  1. {
  2.   "code": 200,
  3.   "data": "更新成功"
  4. }

删除公告信息

  1. {
  2.   "code": 200,
  3.   "data": "删除成功"
  4. }

获取所有公告信息

  1. GET /lbms/notice/page/1 HTTP/1.1
  2. Host: localhost:8080
  3. Cache-Control: no-cache
  4. Postman-Token: 2fe777b8-ea00-e5e5-2ea2-016b77557e18
  1. {
  2.   "code": 200,
  3.   "data": {
  4.     "currentPage": 1,
  5.     "pageSize": 8,
  6.     "recordCount": 1,
  7.     "recordList": [
  8.       {
  9.         "noticeid": 1,
  10.         "noticetile": "通知",
  11.         "noticecontent": "今天下午所有实验课取消",
  12.         "date": null
  13.       }
  14.     ],
  15.     "pageCount": 1,
  16.     "beginPageIndex": 1,
  17.     "endPageIndex": 1
  18.   }
  19. }

获取项目批次下所有成绩

  1. GET /lbms/test/batch/1 HTTP/1.1
  2. Host: localhost:8080
  3. Cache-Control: no-cache
  4. Postman-Token: 2fe777b8-ea00-e5e5-2ea2-016b77557e18
  1. {
  2.   "code": 200,
  3.   "data": [
  4.     {
  5.       "testid": 2,
  6.       "batid": 1,
  7.       "numid": 4,
  8.       "grade": "2014",
  9.       "results": 98,
  10.       "date": null
  11.     }
  12.   ]
  13. }

学生相关接口

获取已经预约项目

  1. {
  2.   "code": 200,
  3.   "data": [
  4.     {
  5.       "batid": 1,
  6.       "itemid": 1,
  7.       "teaid": 1,
  8.       "laboratory": "FF104",
  9.       "date": "2017-02-12",
  10.       "segmentation": "5,6节",
  11.       "sure": null
  12.     }
  13.   ]
  14. }

预约项目

  1. PUT /lbms/batch/student/1&4 HTTP/1.1
  2. Host: localhost:8080
  3. Cache-Control: no-cache
  4. Postman-Token: e97e2df2-0eca-d037-2dda-25af7578c1a0
  5. Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
  7. ------WebKitFormBoundary7MA4YWxkTrZu0gW--
  1. {
  2.   "code": 200,
  3.   "data": "创建成功"
  4. }

获取学生成绩

  1. GET /lbms/test/1&4 HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/json
  4. Cache-Control: no-cache
  5. Postman-Token: 72cb8d72-bb7d-4fcb-9733-7c96464d1114
  1. {
  2.   "code": 200,
  3.   "data": {
  4.     "testid": 2,
  5.     "batid": 1,
  6.     "numid": 4,
  7.     "grade": "2014",
  8.     "results": 98,
  9.     "date": null
  10.   }
  11. }

获取相关学生信息

  1. GET /lbms/student/4 HTTP/1.1
  2. Host: localhost:8080
  3. Cache-Control: no-cache
  4. Postman-Token: b24a47c2-9b85-7efc-e412-0a54ed45ae2a
  1. {
  2.   "code": 200,
  3.   "data": {
  4.     "numid": 4,
  5.     "name": "喵帕斯",
  6.     "sex": "1",
  7.     "specialization": "软件",
  8.     "grade": "2014",
  9.     "date": "2017-02-12 11:16:59.0",
  10.     "contact": "15667027637"
  11.   }
  12. }

更新相关学生密码信息

  1. POST /lbms/cipher/student HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/x-www-form-urlencoded
  4. Cache-Control: no-cache
  5. Postman-Token: d1498dd1-3662-b012-b08f-4efe02ad4f0e
  7. password=yiranblade&numId=4
  1. {
  2.   "code": 200,
  3.   "data": "更新成功"
  4. }

教师相关接口

获取安排项目

  1. GET /lbms/batch/teacher/1&1 HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/x-www-form-urlencoded
  4. Cache-Control: no-cache
  5. Postman-Token: 3746fb4a-53bf-de6c-ae85-a9dcddede472
  1. {
  2.   "code": 200,
  3.   "data": {
  4.     "currentPage": 1,
  5.     "pageSize": 8,
  6.     "recordCount": 1,
  7.     "recordList": [
  8.       {
  9.         "batid": 1,
  10.         "itemid": 1,
  11.         "teaid": 1,
  12.         "laboratory": "FF104",
  13.         "date": "2017-02-12",
  14.         "segmentation": "5,6节",
  15.         "sure": null
  16.       }
  17.     ],
  18.     "pageCount": 1,
  19.     "beginPageIndex": 1,
  20.     "endPageIndex": 1
  21.   }
  22. }

写入学生实验成绩

  1. PUT /lbms/test HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/json
  4. Cache-Control: no-cache
  5. Postman-Token: 14a16e11-c75a-a5b6-ca40-a0e94017e139
  7. {
  8.     "testid":"2",
  9.     "batid":"1",
  10.     "numid":"4",
  11.     "grade":"2014",
  12.     "results":"98"
  13. }
  1. {
  2.   "code": 200,
  3.   "data": "更新成功"
  4. }

获取相关教师信息

  1. {
  2.   "code": 200,
  3.   "data": {
  4.     "teaid": 1,
  5.     "name": "喵帕斯",
  6.     "sex": "0",
  7.     "title": "软件",
  8.     "education": "硕士",
  9.     "date": null,
  10.     "contact": "15667027637"
  11.   }
  12. }

修改相关教师密码

  1. POST /lbms/cipher/teacher HTTP/1.1
  2. Host: localhost:8080
  3. Content-Type: application/x-www-form-urlencoded
  4. Cache-Control: no-cache
  5. Postman-Token: 36c26b44-b81f-c098-0e9a-f580890943cc
  7. password=yiranblade&teaId=1
  1. {
  2.   "code": 200,
  3.   "data": "更新成功"
  4. }

登录相关接口

登录系统

  1. {
  2.   "code": 200,
  3.   "data": "登录成功"
  4. }

获取登录信息

  1. {
  2.   "code": 200,
  3.   "data": {
  4.     "userName": "Zf7WV7XH",
  5.     "userId": 4,
  6.     "power": "student"
  7.   }
  8. }

获取统计信息

  1. {
  2.   "code": 200,
  3.   "data": {
  4.     "high": "98",
  5.     "low": "98",
  6.     "average": "98.0000",
  7.     "grade": "{软件1405}"
  8.   }
  9. }

错误状态码说明

序号 状态码 说明
1 200 请求发送成功
2 400 数据格式错误
4 500 服务器发生未知错误
5 501 请求过于频繁

实验室管理系统新需求

  1. 学生、教师用户能不能做成批量添加，然后批量生成一个表格；
  2. 管理员界面中的项目批次管理，同一个项目的不同时间能不能做成子项目，查看预约学生后，里面的学生能否做一个排序（因为这个系统主要针对通院，所以课程名称会比较有限，看看能不能做一个排序），比如2014级一个框，然后按学号再排一个序；
  3. 教师页面，不知道是否方便加一个所有已经预约的项目的列表展示，方便老师查看（如果可以做成按时间排序，感激不尽）；
  4. 根据项目列表，老师可以查看还未预约的时间，然后发申请给管理员，请求预约此时间段的课程（这个我感觉老师提的怪怪的，麻烦两位评估）；
  5. 录入成绩后，不知道能否做一个统计信息呢？，比如平均分，最高、最低分（如果能按照班级分块排序，那就更好了，这个也需要两位评估看看，是否好实现）；
  6. 另外就是学生页面能不能有一个实验室的基本信息展示页面，比如介绍院里面实验室的基本概况（这个实验室上什么课，有哪些老师之类的）；
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注