REST routes 概览

本页面列出了所有 REST routes 及其简要说明，并提供了详细页面的链接。
在深入了解每条 route 的描述之前，建议先阅读与服务器协作。

---

信息

如需快速导航，可以使用以下两个标签页之一：

• 按数据对象分类的 Routes，了解针对不同操作应使用哪些 routes
• 按方法分类的 Routes，通过 HTTP 方法快速浏览 routes 及服务器返回内容

按数据对象分类的 Routes

tasks

使用以下 routes 对任务执行操作：

HTTP 方法	Route	描述
GET	/tasks	获取所有任务的数据，并返回包含任务对象数组的 json 对象
GET	/tasks/projects	获取指定项目的所有任务数据，并返回包含该项目所有任务对象数组的 json 对象
POST	/tasks	创建新任务，并返回包含新任务 ID 的任务对象
POST	/clone	创建任务副本，并返回包含客户端任务 ID 和服务器复制任务 ID 的 json 对象
PUT	/tasks	更新指定任务的数据，并返回空 json 对象
PUT	/move	将任务移动到指定位置，并返回空 json 对象
PUT	/sort	按指定参数对当前项目的所有任务进行排序，并返回空 json 对象
DELETE	/tasks	删除任务数据，并返回空 json 对象

projects

使用以下 routes 对项目执行操作：

HTTP 方法	Route	描述
GET	/projects	获取所有项目的数据，并返回包含项目对象数组的 json 对象
POST	/projects	创建新项目，并返回包含项目 ID 的项目对象
PUT	/projects	更新项目数据，并返回空 json 对象
DELETE	/projects	删除项目数据，并返回空 json 对象

users

使用以下 routes 对用户执行操作：

HTTP 方法	Route	描述
GET	/users	获取所有用户的数据，并返回包含用户对象数组的 json 对象

tags

使用以下 routes 对标签执行操作：

HTTP 方法	Route	描述
GET	/tags	获取所有标签的数据，并返回包含这些标签数组的 json 对象

按方法分类的 Routes

GET

名称	描述
GET /users	返回包含所有用户对象数组的 json 对象
GET /tasks	返回包含所有任务对象数组的 json 对象
GET /projects	返回包含所有可用项目对象数组的 json 对象
GET /tags	返回包含所有默认标签数组的 json 对象
GET /tasks/projects	返回包含指定项目所有任务对象数组的 json 对象

POST

名称	描述
POST /clone	返回包含客户端任务 ID 和服务器复制任务 ID 的 json 对象。
POST /projects	返回包含项目 ID 的新项目对象
POST /tasks	返回包含新任务 ID 的新任务对象

PUT

名称	描述
PUT /move	任务成功按请求移动时，返回空 json 对象
PUT /sort	任务成功按请求排序时，返回空 json 对象
PUT /tasks	任务成功按请求修改时，返回空 json 对象
PUT /projects	项目成功按请求修改时，返回空 json 对象

DELETE

名称	描述
DELETE /tasks	任务成功删除时，返回空 json 对象
DELETE /projects	项目成功删除时，返回空 json 对象