REST API URL 最佳实践

Question

假设我有两个模型。 Project 和 Task。一个任务必须属于一个项目。

以下哪个 URL 端点是最佳做法？

1. 获取https://api.myapp.com/projects/:project_id/tasks/:task_id
2. 获取https://api.myapp.com/tasks/:task_id?project_id=:project_id

对于过滤结果，我总是使用查询参数，但我想知道我们应该用必需的参数做什么？

Answer 1

根据 REST 最佳实践，资源成员应该在 url 中。在您的情况下，这意味着：

https://api.myapp.com/projects/:project_id/tasks/:task_id

查询参数应用作过滤器。例如获取名称以“TEST”开头的所有任务/

https://api.myapp.com/projects/:project_id/tasks/:task_id?nameStartsWith=TEST

---

您可以在此处阅读更多信息：http://www.restapitutorial.com/resources.html 下载 PDF 并查看第 14 页 - 资源命名。