http - 嵌套模型的类似 CRUD 操作的 url 模式

Question

一般模型的CRUD操作url pattern可以是这样的(假设模型是Post):

new: /posts/new(get)
create:/posts/(post)
edit:/posts/edit(get)
update:/posts/1(put)
get:/posts/1(get)

但是如果有嵌套模型“Comment”。

并且“帖子”和“评论”的关联是一对多的。

那么 CURD 操作 url 模式应该是什么样的评论？

new: /posts/1/comments/new   or /comments/new
create:?
edit:?
update:?
.......

什么是最佳实践？

---

更新:

评论的url好像应该是这样的:

Get one comment for one post: /posts/1/comments/1

create: /posts/1/comments

update: /posts/1/comments/1

delete: /posts/1/comments/1

现在我对更新和删除操作很困惑。

用于更新和删除:/posts/1/comments/1

既然指定了评论id，那么请问url里面的/posts/1是否有必要？

Answer 1

我认为关键在于帖子资源是否“包含”评论。请记住，RESTful url 应该是永久链接，因此在您的所有场景下，特定评论的终点不得更改。听起来它包含在内，因此 url 模式可以将评论嵌套在帖子中。如果不是这种情况(例如，评论可以移动到另一个帖子，如果嵌套会更改 url)，那么您需要一个更扁平的结构，其中包含帖子资源引用的/comment/{id} url。

关键是，如果它是一个 RESTful“超媒体 API”，那么就像网络一样，它会不断链接到嵌套或引用的资源。它不依赖于客户端必须理解 REST 模式或关于哪个端点持有引用或包含的特殊知识资源。

http://blog.steveklabnik.com/posts/2012-02-23-rest-is-over

如果“评论”是“帖子”资源下的资源:

([httpVerb]/url)

获取帖子:

[get] /posts/{id}
body has a couple options - either it contains the full deep comments array
(depends on how much data, chat pattern)
{
    id:xxx,
    title:my post,
    comments: [...]
}

... or it just contains the post resource with a url reference to the comments e.g.
{
   id: xxx,
   title: my post,
   commentsUrl: /posts/xxx/comments
}

could also have an option like this (or other options to control depth):
[get] /posts/{id}?deep=true

获取帖子中的评论集合:

[get] /posts/{id}/comments
returns 200 and an array of comments in the response body

为帖子创建评论:

[post] /posts/{id}/comments
body contains json object to create
returns a 201 created

编辑帖子下的评论:

[patch|post] /posts/{id}/comments/{id}
body contains json object with subset of fields/data to update
returns a 200

替换帖子:

[put] /posts/{id}/comment/{id}
body contains json object to *replace*
returns a 200

如果每篇文章有大量评论，您还可以考虑分页模式:

{
    id: xxx,
    title: myPost,
    pages:6,
    commentsUrl:/posts/xxx/comments/page/1
}

然后:

/posts/{id}/comments/pages/{pageNo}

{
    nextPage: /posts/xxx/comments/2,
    pages:7,
    comments:
    [ { ...,...,}]
}

每一页都会引用下一页、页数和该页的一组评论。如果您使用分页模式，那么数组中的每个评论都会有一个指向单个评论的引用 url。

如果您发现自己在 url 中执行操作，则您可能做错了什么。好读:http://blog.steveklabnik.com/posts/2011-07-03-nobody-understands-rest-or-http