规范后端接口.md

以下是规范后的文档内容：

Todolist 应用 API 规范

数据模型

Topic 数据模型

{
    "id": "int",
    "topicTitle": "string",
    "topicDescription": "string"
}

Todo 数据模型

{
    "id": "int",
    "todoTitle": "string",
    "todoContent": "string",
    "todoStatus": "int",
    "topicTitle": "string",
    "deadline": "date"
}

API 接口

获取所有 Topics

• 接口名称：getTopics
• 请求方法：GET
• 路由：/todolist/topics
• 返回类型：list
• 返回内容：由 Topic 对象构成的列表

获取指定 Topic 下的所有 Todos

• 接口名称：getTodosByTopic
• 请求方法：GET
• 路由：/todolist/todos/{id}
• 返回类型：list
• 返回内容：由 Todo 对象构成的列表，这些 Todo 属于指定的 Topic

直接获取所有 Todos

• 接口名称：getTodosAll
• 请求方法：GET
• 路由：/todolist/todos
• 返回类型：list
• 返回内容：所有 Todo 对象的列表

添加 Topic

• 接口名称：addTopic
• 请求方法：POST
• 路由：/todolist/topics
• 发送格式：JSON
• 附加要求：
  • Topic 不能重复。
  • 空 Topic 被视为一个默认的 Topic，但不允许添加空 Topic，因为默认已经存在。

添加 Todo

• 接口名称：addTodo
• 请求方法：POST
• 路由：/todolist/todos
• 发送格式：JSON

删除 Todo

• 接口名称：deleteTodoById
• 请求方法：DELETE
• 路由：/todolist/todos
• 参数：
  • id：待删除的 Todo 的id

删除 Topic

• 接口名称：deleteTopicById
• 请求方法：DELETE
• 路由：/todolist/topics
• 发送格式：JSON
• 参数：
  • id：待删除的 Topic 的id

更新 Todo 完成状态

• 接口名称：updateTodoStatusById
• 请求方法：UPDATE
• 路由：/todolist/todos
• 发送格式：JSON
• 参数：
  • id：待更新的 Todo 的id
  • status: 待更新的Todo 的目前的状态

更新 Todo 内容，包括 Topic 及其他内容

• 接口名称：updateTodoRecordById

• 请求方法：UPDATE

• 路由：/todolist/todos

• 发送格式：JSON

  {
    
  
  }

更新 Topic 内容

• 接口名称：updateTopicById
• 请求方法：UPDATE
• 路由：/todolist/topics/{topicId}