美文网首页
TodoList项目接口文档

TodoList项目接口文档

作者: 夏海峰 | 来源:发表于2020-06-03 14:58 被阅读0次
原型
  • 原型地址:http://www.todolist.cn/
  • baseUrl = 'http://10.36.132.232:9999'

1、获取我的所有任务

  • 接口说明:包括待完成和未完成的任务。
  • 请求URL:/todo/getMyTodos
  • 请求方式:GET
  • 入参示例:
  {
    userId: String,    // 学号,必填,示例:'SZ201900000'
  }
  • 出参示例:
{
    "err": 0,
    "msg": "success",
    "data": {
      // 待完成的任务列表
      "undone": [    
        {
            "_id": "5e0189667e18221ee819c777",   // 任务id
            "userId": "1",                       // 你的学号
            "task": "跑步",                      // 任务名称
            "status": "0",                       // 任务的状态,0-待完成  1-已完成
            "createTime": 1577159014331,         // 任务的创建时间
            "__v": 0
        }
      ],
      // 已完成的任务列表
      "done": [    
          {
              "_id": "5e0189627e18221ee819c776",
              "userId": "1",
              "task": "跑步2233",
              "status": "1",
              "createTime": 1577159010121,
              "__v": 0
          }
      ]
    }
}

2、添加一条新任务

  • 请求URL:/todo/addTodo
  • 请求方式:POST
  • 入参示例:
{
    userId: String,   // 学号,必填
    task: String      // 任务名称,必填
}

3、删除一条任务

  • 请求URL:/todo/deleteTodo
  • 请求方式:GET
 {
    userId: String,    // 你的学号,必填
    id: String,        // 任务的id,必填
 }

4、切换任务的状态

  • 请求URL:/todo/changeTodoStatus
  • 请求方式:GET
  • 入参示例:
{
    userId: String,   // 你的学号,必填
    id: String,       // 任务id,必填
    status: String,   // 必填,'0'-表示把任务变成“正在进行”  '1'-表示把任务变成“已完成”
}

5、修改任务名称

  • 请求URL:/todo/editTodo
  • 请求方式:POST
  • 入参示例:
{
    userId: String,   // 学号,必填
    id: String,       // 当前任务id,必填
    task: String      // 新的任务名称,必填
}

END !!!

相关文章

网友评论

      本文标题:TodoList项目接口文档

      本文链接:https://www.haomeiwen.com/subject/vwfbzhtx.html