JSON-API设计

Question

假设我有不同种类的对象House和Car。现在我想添加评论。

最好的做法是什么？ 有终点：

/api/house/:houseId/comments

/api/car/:carId/comments

或者征求意见一般般API：

/api/comments/:generalId

Answer 1

我的产品类型是实现细节。要REST风格我会创建API与

/API /产品/的[ProductID]

此端点会询问服务GET（获取给定的产品），POST（更新指定产品），删除

/API /产品/

该终端将支持GET（获取所有的产品），PUT（创建新产品）

这个端点将支持GET（获得给定产品的给定注释）和POST（更新给定注释），DELETE（删除给定评论）。这个端点将支持GET（给定注释）。 在这种情况下，commentID可能是唯一的每个资源，而不是全局。

/API /产品/的[ProductID] /评论

该终端将支持GET（获取产品的所有评论）和PUT（创建新的注释），删除（删除产品所有评论）

API /评论/ [commentId]

此资源（与操作GET，POST，DELETE）也很好。但它需要全球独一无二的评论。如果您需要在不知道productId的情况下管理单独的评论，请随意公开此类端点。这并不违反REST。

在这个API设计中，我们为每个产品和评论分别提供资源。 我们还拥有所有产品的资源，并为给定产品的所有评论提供资源。每个资源可能支持GET，POST，PUT，DELETE。你可能ommit某些操作（例如不暴露于/api/product/[productID]/comments/[commentID]POST当你不希望支持编辑点评

编辑：。在由@lospejos评论建议你可以使用复数形式（产品，评论）无论哪种方式，你的API将是REST风格，每个帖子/评论都是独立的资源。