Skip to content

Latest commit

 

History

History
256 lines (245 loc) · 6.88 KB

后端接口.md

File metadata and controls

256 lines (245 loc) · 6.88 KB
Raw

接口文档v1.0

1. 注册

1.1 功能描述

调用微信接口获取用户openid，发送至后端注册

1.2 请求说明

请求方式：POST
请求URL ：/register

1.3 请求参数

字段 字段类型 字段说明
openid string 微信openid

1.4 返回结果

{
  "data": {
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vc2FsZS1hcGkuZGV2L2xvZ2luIiwiaWF0IjoxNDkxNTMyOTI4LCJleHAiOjE0OTIyNTI5MjgsIm5iZiI6MTQ5MTUzMjkyOCwianRpIjoiN1hCUXdwN1FHZmxUdHVVQiIsInV1aWQiOiI1MDZjYWY3MCJ9.FyyXagHtBfDBtMJZPV_hm2q6CVULpY63JPDGDHXc"
  },
  "code": "200",
  "msg": "SUCCESS"
}

1.5 返回参数

字段 字段类型 字段说明
token string token值

1.6 错误状态码

状态码 说明
500 注册失败！

2.登录

2.1 功能描述

通过微信api获取到的openid向后端登录。

2.2 请求说明

请求方式：POST
请求URL ：/login

2.3 请求参数

字段 字段类型 字段说明
openid string 微信openid
password string njuTeacher

2.4 返回结果

{
  "data": {
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vc2FsZS1hcGkuZGV2L2xvZ2luIiwiaWF0IjoxNDkxNTMyOTI4LCJleHAiOjE0OTIyNTI5MjgsIm5iZiI6MTQ5MTUzMjkyOCwianRpIjoiN1hCUXdwN1FHZmxUdHVVQiIsInV1aWQiOiI1MDZjYWY3MCJ9.FyyXagHtBfDBtMJZPV_hm2q6CVULpY63JPDGDHXc"
  },
  "code": "200",
  "msg": "SUCCESS"
}

2.5 返回参数

字段 字段类型 字段说明
token string token值

2.6 错误状态码

状态码 说明
1001 用户未注册

3. 搜索

3.1 功能描述

3.2 请求说明

请求方式：GET
请求URL ：/search

3.3 请求参数

字段 字段类型 字段说明
input string 搜索的输入字段

3.4 返回结果

{
  "data": [{
    "teacherId": string,
    "teacherName": string,
    "teacherDepartment": string,
    "teacherScore": number
  }],
  "code": "200",
  "msg": "SUCCESS"
}

3.5 错误状态码

状态码 说明

4. 搜索内容预加载（暂定）

4.1 功能描述

4.2 请求说明

请求方式：GET
请求URL ：/searchPreloading

4.3 请求参数

字段 字段类型 字段说明
input string 用户已输入的字段

4.4 返回结果

{
  "data": [],
  "code": "200",
  "msg": "SUCCESS"
}

4.5 返回参数

字段 字段类型 字段说明
data Array 直接在data里放一个与输入相关的搜索内容列表供用户选择

4.6 错误状态码

状态码 说明

5.老师信息获取

5.1 功能描述

5.2 请求说明

请求方式：GET
请求URL ：/getTeacherInfo

5.3 请求参数

字段 字段类型 字段说明
teacherId string 老师id

5.4 返回结果

{
  "data": {
      "teacherName": string,
      "teacherScore": number,
      "teacherCollegename": string,
      "participantNum": number,
      "department": string,
      "courses": [{
          "name": string,
          "courseId": string
      }]
  },
  "code": "200",
  "msg": "SUCCESS"
}

5.5 返回参数

字段 字段类型 字段说明

5.6 错误状态码

状态码 说明

6.评价信息获取

6.1 功能描述

6.2 请求说明

请求方式：GET
请求URL ：/getCommentInfo

6.3 请求参数

字段 字段类型 字段说明
teacherId string 老师id
courseId string 若为空，则返回老师所有的评价，否则，返回courseId相关的评价

6.4 返回结果

{
  "data": [{
      "commentId": string,
      "commentContent": string,
      "commentTime": date,
      "commentStars": number,
      "courseId": string,
      "userId": string,
      "likeNum": number
  }],
  "code": "200",
  "msg": "SUCCESS"
}

6.5 返回参数

字段 字段类型 字段说明

6.6 错误状态码

状态码 说明

7.用户进行评价

7.1 功能描述

7.2 请求说明

请求方式：POST
请求URL ：/makeComment

7.3 请求参数

字段 字段类型 字段说明
openid string 用户的微信openid
courseId string 对老师所上的某课程进行评价
starNum number 评论星数
content string 评价内容

7.4 返回结果

{
  "code": "200",
  "msg": "SUCCESS"
}

7.5 返回参数

字段 字段类型 字段说明

7.6 错误状态码

状态码 说明

8.用户进行点赞

8.1 功能描述

8.2 请求说明

请求方式：GET
请求URL ：/thumbsUp

8.3 请求参数

字段 字段类型 字段说明
openid string 用户的微信openid
commentId string 点赞对象id
likeIt number 若为1，则为喜欢；为0，则不喜欢

8.4 返回结果

{
  "code": "200",
  "msg": "SUCCESS"
}

8.5 返回参数

字段 字段类型 字段说明

8.6 错误状态码

状态码 说明

9.查询是否已点赞

9.1 功能描述

传入需检查的评论id和用户id，返回一个用户对这些评价的点赞情况

9.2 请求说明

请求方式：POST
请求URL ：/getUserDoFavouriteSituation

9.3 请求参数

字段 字段类型 字段说明
openid string 用户的微信openid
commentIds array 评论id的一个list

9.4 返回结果

[
  {"commentId":"6dbae9ecdae1400cb493ea91b246c5bd","favouriteSituation":false},   {"commentId":"7fe6c84046fb11e9bb6648f17f657e2c","favouriteSituation":true},{"commentId":"80dfa2ee46fb11e9835c48f17f657e2c","favouriteSituation":null}
  ]

9.5 返回参数

字段 字段类型 字段说明
favouriteSituation boolean 若为true则用户是点赞了；若为false，则用户差评；若为null，则用户未进行点赞

9.6 错误状态码

状态码 说明