Skip to content

接口文档

Jump to bottom
bigC edited this page Jul 10, 2022 · 78 revisions

地址：http://8.131.89.181:7001 账号：xiaoming 密码: 999999

用户

登录接口 /user/login

  1. 接口名 ：/user/login;
  2. 类型 ： 'POST'
  3. 描述：此接口用来进行cms登录
  4. 入参: 
    var data = {
    username: <string>,   //必填    用户名
    password: <string>,   //必填    密码，该密码要通过rsa加密
    captcha : <string>,    //必填    验证码
}
  5. 出参： 
    var res = {
    status: <number>,       //状态   1：成功      0：失败
    msg   : <string>,       //返回描述信息
    data  : <string>        //token    注：当调用服务端其它需要登录的接口时，需要把token放到请求头的authorization中传给服务端
}
  6. rsa的使用文档： https://github.com/bo-ddd/courseware/blob/master/vue2.x%2Belementui/22.%20rsa.md

验证码接口 /captcha

  1. 接口名 ：/captcha;
  2. 类型 ： 'GET'
  3. 描述：此接口用来获取验证码
    //接口返回数据：
    let res  =  '图片'    //res是img标签的src

注册接口 /user/register

  1. 接口名 /user/register
  2. 类型:'post',
  3. 描述:'这个是注册接口';
  4. 入参:
   var data = {
       username : <string>,   //必填 用户名称
       password : <string>,   //必填 用户密码
       email    : <string>,   //必填 用户邮箱
       phone    : <string>,   //必填 手机号码
       captcha  : <string>,   //必填 验证码
       name     : <string>,   //必填 真实姓名
   }
  1. 出参:
   var res = {
       status : <number>, //状态   1：成功      0：失败
       msg    : <string>, //返回描述信息
       data   : []        //成功后返回的数据
   }

查询用户信息列表 /user/list

  1. 接口名: /user/list
  2. 类型 ：'POST'
  3. 描述：此接口用来查询用户信息列表
  4. 入参:
var params = {
  pagination : <boolean>,    //非必填  表示是否需要分页  如果传 false：不分页   true:分页   默认不传是分页; 
  pageSize   : <number>,     //非必填  每页获取几条数据  如果不传 默认是获取10条；
  pageNum    : <number>,     //非必填  想获取第几页的数据  如果不传 默认是第1页；
}
  1. 出参
var res = {
    status : <number>,   //状态   1：成功    0：失败
    msg : <string>,      //返回描述信息
    data:{
      count : <number>    //数据库共多少条
      pageCount : <number> //共多少页
      rows:[
      {
        id    : <number>,    //个人id
        phone : <string>,    //手机号 
        email : <string>,    //邮箱 
        sex   : <number>,    //性别 1 ： 男   0： 女
        avatarName: <string>, //昵称
        name  ：<string>,    //真实姓名
        provinceNo: <string>,  //省编号
        cityNo: <string>,    //市编号
        areaNo: <string>,    //区编号
        townNo: <string>,    //镇编号
        desc:   <string>,    //个人介绍
      }
      ]
    }
}

个人信息接口 /user/info

  1. 接口名：'/user/info';
  2. 类型：'post';
  3. 入参：{}
  4. 出参：
var res = {
    status  :<number>,      // 1： 成功   0：失败
    msg:<string>,
    data:{
        id    : <number>,    //个人id
        phone : <string>,    //手机号 
        email : <string>,    //邮箱 
        sex   : <number>,    //性别 1 ： 男   0： 女
        avatarName: <string>, //昵称
        avatarImg:<string>,  //头像
        name  ：<string>,    //真实姓名
        provinceNo: <string>,  //省编号
        cityNo: <string>,    //市编号
        areaNo: <string>,    //区编号
        townNo: <string>,    //镇编号
        desc:   <string>,    //个人介绍
    }
}

修改个人信息接口 /user/update

  1. 接口名：'/user/update';
  2. 类型：'post';
  3. 入参：
let params =  {
        phone : <string>,    //手机号 
        email : <string>,    //邮箱 
        sex   : <number>,    //性别 1 ： 男   0： 女
        avatarName: <string>, //昵称
        avatarImg:<string>,  //头像
        name  ：<string>,    //真实姓名
        provinceNo: <string>,  //省编号
        cityNo: <string>,    //市编号
        areaNo: <string>,    //区编号
        townNo: <string>,    //镇编号
        desc:   <string>,    //个人介绍
}
//注： 修改哪个参数传哪一个参数;
  1. 出参：
var res = {
    status  :<number>,      // 1： 成功   0：失败
    msg:<string>,
    data:[]
}

退出登录接口 /user/logout

  1. 接口名:'/user/logout'
  2. 类型 ：'POST'
  3. 描述：此接口用来退出登录
  4. 入参:
var params = {}
  1. 出参
var res = {
    status: <number>,     //状态   1：成功    0：失败
    msg   : <string>,       //返回描述信息
    data  : []
}

查询题库列表 /question/list

  1. 接口名: /question/list
  2. 类型 ：'POST'
  3. 描述：此接口用来查询题库列表
  4. 入参:
var params = {
  type       : <number>,     // 必填项  题目类型  1：单选题  2：多选题  3：填空题  4：问答题   注：暂只支持单选；
  pagination : <boolean>,    //非必填  表示是否需要分页  如果传 false：不分页   true:分页   默认不传是分页; 
  pageSize   : <number>,     //非必填  每页获取几条数据  如果不传 默认是获取10条；
  pageNum    : <number>,     //非必填  想获取第几页的数据  如果不传 默认是第1页；
  title      : <string>,     //非必填  题目标题 模糊查询
}
  1. 出参
var res = {
    status : <number>,     //状态   1：成功    0：失败
    msg : <string>,      //返回描述信息
    data:{
      count : <number>    //数据库共多少条
      pageCount : <number> //共多少页
      rows:[
         {
           id:<number>,   //题目标识
           type:<number>, //题目类型
           title:<string>, //题目标题
           questionA:<string>,  // 选项a,
           questionB:<string>,  // 选项b,
           questionC:<string>,  // 选项c,
           questionD:<string>,  // 选项d,
           answer:<string>,     // 答案
           level: <number>,     // 难度系数  1：简单  2：普通 3：困难
           createdAt:<date>，   // 创建时间
           updatedAt:<date>,    // 更新时间
         }
      ]
    }
}

创建题 /question/create

  1. 接口名: /question/create
  2. 类型 ：'POST'
  3. 描述：此接口用来创建题
  4. 入参:
var params = {
      type:<number>, //题目类型
      title:<string>, //题目标题
      questionA:<string>,  // 选项a,
      questionB:<string>,  // 选项b,
      questionC:<string>,  // 非必填 选项c,
      questionD:<string>,  // 非必填 选项d,
      answer:<string>,     // 答案  如果是单选题则传 A 或者  B 或  C 或 D (大写)
      level: <number>,     // 难度系数  1：简单  2：普通 3：困难
}
  1. 出参
var res = {
    status:<number>,     //状态   1：成功    0：失败
    msg:<string>,       //返回描述信息
    data:[] 
}

修改题 /question/update

  1. 接口名: /question/update
  2. 类型 ：'POST'
  3. 描述：此接口用来修改题
  4. 入参:
var params = {
      id: <number>,   // 必填 题目id
      type:<number>,  // 必填 题目类型
      title:<string>, // 非必填 题目标题
      questionA:<string>,  // 选项a,
      questionB:<string>,  // 选项b,
      questionC:<string>,  // 非必填 选项c,
      questionD:<string>,  // 非必填 选项d,
      answer:<string>,     // 答案  如果是单选题则传 A 或者  B 或  C 或 D (大写)
      level: <number>,     // 难度系数  1：简单  2：普通 3：困难
}
//注释： 修改的入参，必传项是id,和type, 其它的参数是修改哪个传哪个，入参的key的数量必须  >= 3；
  1. 出参
var res = {
    status:<number>,     //状态   1：成功    0：失败
    msg:<number>,       //返回描述信息
    data:[] 
}

删除题 /question/delete

  1. 接口名: /question/delete
  2. 类型 ：'POST'
  3. 描述：此接口用来删除题
  4. 入参:
var params = {
      id: <number>,   // 必填项 题目id
      type:<number>,  // 必填 题目类型
}
  1. 出参
var res = {
    status:<number>,     //状态   1：成功    0：失败
    msg:<string>,     //返回描述信息
    data:[] 
}

查询我的记事薄列表 /diary/list

  1. 接口名: /diary/list
  2. 类型 ：'POST'
  3. 描述：查询我的记事薄列表
  4. 入参:
var params = {
  pagination : <boolean>,    //非必填  表示是否需要分页  如果传 false：不分页   true:分页   默认不传是分页; 
  pageSize   : <number>,     //非必填  每页获取几条数据  如果不传 默认是获取10条；
  pageNum    : <number>,     //非必填  想获取第几页的数据  如果不传 默认是第1页；
}
  1. 出参
var res = {
    status : <number>,     //状态   1：成功    0：失败
    msg : <string>,      //返回描述信息
    data:{
      count : <number>    //数据库共多少条
      pageCount : <number> //共多少页
      rows:[
         {
           id:<number>, 
           content:<string>, //记事薄内容
           userId:<number>,  // 用户id;
           progress:<number>, //进度  默认是0 最大填 100  指的是当前工作任务的进度；
           createdAt:<date>，   // 创建时间
           updatedAt:<date>,    // 更新时间
         }
      ]
    }
}

增加我的记事薄 /diary/create

  1. 接口名: /diary/create
  2. 类型 ：'POST'
  3. 描述：增加我的记事薄
  4. 入参:
var params = {
     content:<string>, //记事薄内容
     progress:<number>, //进度  默认是0 最大填 100  指的是当前工作任务的进度；
}
  1. 出参
var res = {
    status : <number>,     //状态   1：成功    0：失败
    msg : <string>,      //返回描述信息
    data:[]
}

进入聊天室 addUser

  1. 接口名: addUser
  2. 类型 ：socket
  3. 描述：进入聊天室
  4. 入参:
var params = {
     userId:<string>, //用户ID
     avatarName: <string>,  //用户昵称
} 
//注： 前端通过  this.$socket.emit()方法进行调用，  第一个参数填接口名称，是一个string类型的，第二个参数是当前接口的入参；

离开聊天室 removeUser

  1. 接口名: removeUser
  2. 类型 ：socket
  3. 描述：离开聊天室
  4. 入参:
var params = {
     userId:<string>, //用户ID
     avatarName: <string>,  //用户昵称
} 
//注： 前端通过  this.$socket.emit()方法进行调用，  第一个参数填接口名称，是一个string类型的，第二个参数是当前接口的入参；

获取用户总数 userCount

  1. 接口名: userCount
  2. 类型 ：socket
  3. 描述：获取用户总数
  4. 出参:
var count = <number>  //当前在线人数
//注： 前端通过sockets钩子中的 userCount 方法来接收；

发送聊天信息 sendMsg

  1. 接口名: sendMsg
  2. 类型 ：socket
  3. 描述：发送聊天信息
  4. 入参:
var params = {
     userId:<string>, //用户ID
     type:1,   // 1：文本   2：图片   3：表情 emoje;
     avatarName:<string>,  //用户昵称
     msg:<string>, //发送的文本消息
} 
//注： 前端通过  this.$socket.emit()方法进行调用，  第一个参数填接口名称，是一个string类型的，第二个参数是当前接口的入参；

接收聊天信息 receiveMsg

  1. 接口名: receiveMsg
  2. 类型 ：socket
  3. 描述：接收聊天信息
  4. 出参:
var res = {
     userId:<string>, //用户ID
     type:1,   // 1：文本   2：图片   3：表情 emoje;
     avatarName:<string>,  //用户昵称
     msg:<string>, //发送的文本消息
} 
//注： 前端通过sockets钩子中的 receiveMsg 方法来接收；

创建任务 /task/create

  1. 接口名: /task/create
  2. 类型 ：'POST'
  3. 描述：此接口用来创建任务
  4. 入参:
var params = {
      name:<string>, //任务名称
      desc:<string>, //任务描述
      duration: <number>,  //任务时长
      level:<number>,  // 任务等级  1：紧急  0：普通任务
}
  1. 出参：
let res = {
  status:<number>, //1： 成功  0：失败
  msg:<string>,    //提示信息
  data:{
    id:<number>,  //任务的id
  }
}

编辑任务 /task/update

  1. 接口名: /task/update
  2. 类型 ：'POST'
  3. 描述：此接口用来编辑任务
  4. 入参:
var params = {
      id  :<number>, //任务id
      name:<string>, //任务名称
      desc:<string>, //任务描述
      duration: <number>,  //任务时长
      level:<number>,  // 任务等级  1：紧急  0：普通任务
}
let res = {
  status:<number>,
  msg:<string>,
  data:[]
}

发布/领取任务 /task/release

  1. 接口名： /task/release
  2. 类型： "POST"
  3. 描述： 此接口是用来发布/领取任务
  4. 入参：
var params = {
  userIds:<array[<number>]>,  //用户id，  如果给多个人发送任务，可以传数组，数组中是每一个人的id； 
  taskId:number,  //任务id   
}

查询任务列表 /task/list

  1. 接口名: /task/list
  2. 类型 ：'POST'
  3. 描述：此接口用来查询任务列表
  4. 入参:
var params = {
  taskName   : <string>      //非必填  模糊查询  根据任务名进行
  pagination : <boolean>,    //非必填  表示是否需要分页  如果传 false：不分页   true:分页   默认不传是分页; 
  pageSize   : <number>,     //非必填  每页获取几条数据  如果不传 默认是获取10条；
  pageNum    : <number>,     //非必填  想获取第几页的数据  如果不传 默认是第1页；
}
  1. 出参
var res = {
    status : <number>,     //状态   1：成功    0：失败
    msg : <string>,      //返回描述信息
    data:{
      count : <number>    //数据库共多少条
      pageCount : <number> //共多少页
      rows:[
         {
           id:<number>,   //任务id
           isReceived:<number>, // 任务领取状态，  1：已领取， 0：未领取
           userId:<string>, // 创建任务的人Id
           userName:<string>, //创建任务人的真实姓名;
           taskName:<string>, // 任务名称
           level: <number>,     // 紧急程度 1：紧急 0：普通
           desc:<string>,  //任务描述
           duration:<string>, // 任务时长范围
           createdAt:<date>，   // 创建时间
           updatedAt:<date>,    // 更新时间
         }
      ]
    }
}

查询任务详情 /task/detail

  1. 接口名: /task/detail
  2. 类型 ：'POST'
  3. 描述：此接口用来查询任务详情
  4. 入参:
var params = {
  taskId : <number>,    //任务id
}
  1. 出参
var res = {
    status : <number>,     //状态   1：成功    0：失败
    msg : <string>,      //返回描述信息
    data:{
      taskId:<number>,   //任务id
      userId:<string>, // 创建任务的人Id
      userName:<string>, //创建任务人的真实姓名;
      taskName:<string>, // 任务名称
      level: <number>,     // 紧急程度 1：紧急 0：普通
      desc:<string>,  //任务描述
      duration:<string>, // 任务时长范围
      createdAt:<date>，   // 创建时间
      updatedAt:<date>,    // 更新时间
      receivedData:[       // 已领取任务人列表信息
        {
          taskId: <number>, //任务d,
          userId: <number>, //用户id,
          userName: <string>, //用户名称
          completedAt: <date> or null,  //任务完成时间
        }
      ]
    }
}

创建角色 /role/create

  1. 接口名: /role/create
  2. 类型 ：'POST'
  3. 描述：此接口用来创建角色
  4. 入参:
var params = {
      roleName:<string>, //角色名字
      groupId :<number>,  //分组id  非必填
}
  1. 出参
var res = {
    status:<number>,     //状态   1：成功    0：失败
    msg:<string>,       //返回描述信息
    data:[] 
}

角色列表 /role/list

  1. 接口名: /role/list
  2. 类型 ：'POST'
  3. 描述：此接口用来获取角色列表
  4. 入参:
var params = {
  pagination : <boolean>,    //非必填  表示是否需要分页  如果传 false：不分页   true:分页   默认不传是分页; 
  pageSize   : <number>,     //非必填  每页获取几条数据  如果不传 默认是获取10条；
  pageNum    : <number>,     //非必填  想获取第几页的数据  如果不传 默认是第1页；
}
  1. 出参
var res = {
    status : <number>,     //状态   1：成功    0：失败
    msg : <string>,      //返回描述信息
    data:{
      count : <number>    //数据库共多少条
      pageCount : <number> //共多少页
      rows:[
         {
           id:<number>,   //角色id
           roleName:<string>, // 角色的名字
           groupId : <number> // 分组的id
           createdAt:<date>，   // 创建时间
           updatedAt:<date>,    // 更新时间
         }
      ]
    }
}

创建角色组 /roleGroup/create

  1. 接口名: /roleGroup/create
  2. 类型 ：'POST'
  3. 描述：此接口用来创建角色组
  4. 入参:
var params = {
      groupName:<string>, //分组名字
}
  1. 出参
var res = {
    status:<number>,     //状态   1：成功    0：失败
    msg:<string>,       //返回描述信息
    data:[] 
}

角色分组列表 /roleGroup/list

  1. 接口名: /roleGroup/list
  2. 类型 ：'POST'
  3. 描述：此接口用来获取角色分组列表
  4. 入参:
var params = {
  pagination : <boolean>,    //非必填  表示是否需要分页  如果传 false：不分页   true:分页   默认不传是分页; 
  pageSize   : <number>,     //非必填  每页获取几条数据  如果不传 默认是获取10条；
  pageNum    : <number>,     //非必填  想获取第几页的数据  如果不传 默认是第1页；
}
  1. 出参
var res = {
    status : <number>,     //状态   1：成功    0：失败
    msg : <string>,      //返回描述信息
    data:{
      count : <number>    //数据库共多少条
      pageCount : <number> //共多少页
      rows:[
         {
           id:<number>,   //分组id
           groupName:<string>, // 分组的名字
         }
      ]
    }
}

创建评论 /comment/create

  1. 接口名: /comment/create
  2. 类型 ：'POST'
  3. 描述：此接口用来创建评论
  4. 入参:
var params = {
      commentContent:<string>, //要评论的内容
      taskId:<number> //要评论任务的id
      userId:<number> //评论的用户id  是谁评论的
}
  1. 出参
var res = {
    status:<number>,     //状态   1：成功    0：失败
    msg:<string>,       //返回描述信息
    data:[] 
}

获取评论列表 /comment/list

  1. 接口名: /comment/list
  2. 类型 ：'POST'
  3. 描述：此接口用来获取评论列表
  4. 入参:
var params = {
  pagination : <boolean>,    //非必填  表示是否需要分页  如果传 false：不分页   true:分页   默认不传是分页; 
  pageSize   : <number>,     //非必填  每页获取几条数据  如果不传 默认是获取10条；
  pageNum    : <number>,     //非必填  想获取第几页的数据  如果不传 默认是第1页；
}
  1. 出参
var res = {
    status : <number>,     //状态   1：成功    0：失败
    msg : <string>,      //返回描述信息
    data:{
      count : <number>    //数据库共多少条
      pageCount : <number> //共多少页
      rows:[
         {
           commentId:<number>       // 此条评论的id
           commentContent:<string>  // 评论的内容
           commentCreatedAt:<date>  // 评论的时间
           taskId: <string>  //评论的任务的id
           taskName:<string> //评论的任务的名字
           userId: <number>  //评论的用户的id
           username: <string> //评论的用户的名字
         }
      ]
    }
}

根据角色查询对应的权限列表 /jurisdiction/list

  1. 接口名: /jurisdiction/list
  2. 类型 ：'POST'
  3. 描述：根据角色查询对应的权限列表
  4. 入参:
var params = {
  role:<number>,//角色的身份  1.管理员(老师)  2.学生
}
  1. 出参
var res = {
    status : <number>,     //状态   1：成功    0：失败
    msg : <string>,      //返回描述信息
    data:[
    	 {
           id:   <number>       // id
           title:<string>    // 功能权限名称
         }
    ]
}

获取权限列表 /permission/list

  1. 接口名: /permission/list
  2. 类型 ：'POST'
  3. 描述：此接口用来获取权限列表
  4. 入参:
var params = {
  pagination : <boolean>,    //非必填  表示是否需要分页  如果传 false：不分页   true:分页   默认不传是分页; 
  pageSize   : <number>,     //非必填  每页获取几条数据  如果不传 默认是获取10条；
  pageNum    : <number>,     //非必填  想获取第几页的数据  如果不传 默认是第1页；
}
  1. 出参
var res = {
    status : <number>,     //状态   1：成功    0：失败
    msg : <string>,      //返回描述信息
    data:{
      count : <number>    //数据库共多少条
      pageCount : <number> //共多少页
      rows:[
         {
           id:<number>       // id
           title:<string>    // 标题
           type:<date>      //  类型  1代表左侧栏  2代表页面  3代表功能
           pid: <string>    //   pid如果等于某项id 就是这个的子项    如果是null 就代表没有子项
         }
      ]
    }
}

创建权限 /permission/create

  1. 接口名: /permission/create
  2. 类型 ：'POST'
  3. 描述：此接口用来创建
  4. 入参:
var params = {
      title :<string>, //标题
      type  :<number>  //类型   1代表左侧栏  2代表页面  3代表功能
      pid   :<number>  //pid如果为空就是最大的一级  如果等于某项的id就是它的子级
}
  1. 出参
var res = {
    status:<number>,     //状态   1：成功    0：失败
    msg:<string>,       //返回描述信息
    data:[] 
}

删除权限 /permission/delete

  1. 接口名: /permission/delete
  2. 类型 ：'POST'
  3. 描述：此接口用来删除
  4. 入参:
var params = {
      id: [number],   // 必填项 权限的id
}

修改权限 /permission/update

  1. 接口名：'/permission/update';
  2. 类型：'post';
  3. 入参：
let params =  {
        id   : <number>     //id
        title: <string>,    //标题
        type : <number>,    //类型
        pid  : <number>,    //父id
}
//注： 修改哪个参数传哪一个参数;

创建对应角色的权限 /rolePermission/create

  1. 接口名: /rolePermission/create
  2. 类型 ：'POST'
  3. 描述：此接口用来创建
  4. 入参:
var params = {
      permissionId: [<number>] //选择的那个功能权限的id
      roleId      : <number>   //角色id 
}
  1. 出参
var res = {
    status:<number>,     //状态   1：成功    0：失败
    msg:<string>,       //返回描述信息
    data:[] 
}

获取功能权限列表 /rolePermission/list

  1. 接口名: /rolePermission/list
  2. 类型 ：'POST'
  3. 描述：此接口用来获取功能权限列表
  4. 入参:
var params = {
  pagination : <boolean>,    //非必填  表示是否需要分页  如果传 false：不分页   true:分页   默认不传是分页; 
  pageSize   : <number>,     //非必填  每页获取几条数据  如果不传 默认是获取10条；
  pageNum    : <number>,     //非必填  想获取第几页的数据  如果不传 默认是第1页；
 }
  1. 出参
var res = {
    status : <number>,     //状态   1：成功    0：失败
    msg : <string>,      //返回描述信息
    data:{
      count : <number>    //数据库共多少条
      pageCount : <number> //共多少页
      rows:[
         {
           id       : <number>  //id
           roleName : <string>  //角色名字
           rolePermissionTitle ： <string> //角色权限title
         }
      ]
    }
}
Clone this wiki locally