Spring REST URI 存在检查

Question

让我们假设一个简单的基于 Spring 的 RESTful API 和一些嵌套资源。

• User 是每个人创建的用于访问 API 的根实体
• 每个User 都可以创建Posts，因此Post 没有创建者就无法存在
• User 也可以评论现有的Posts，因此Comment 属于Post

对于这个 API，我选择了以下 RESTful 路由：

• /api/users 为 User
• /api/users/{userId}/posts 为Post
• /api/users/{userId}/posts/{postId}/comments 为Comment

关于我的问题，我是否应该验证父资源是否存在？例如对于请求GET /api/users/2/posts/3/comments/7，我是否应该确保实体User(2) 和Post(3) 也存在？我是否还必须确保实体相互关联，并且没有使用任何 x 存在的任意资源？

示例

@PostMapping("/api/users/{userId}/posts/{postId}/comments")
public void create(@PathVariable("userId") Long userId, @PathVariable("postId") Long postId, @RequestBody CommentPayload payload) {

    // userService.existsByIdWithPostId(userId, postId); ???

    commentService.createForPost(postId, payload);
}

要在数据库中创建评论，userId 完全无关紧要，只需要postId。我是否仍应确保存在userId X 的用户并且有postId Y 的帖子，还是应该忽略它？

如果是，我怎么能优雅地做到这一点？因为像Optional<Comment> findByUserIdAndPostIdAndId(...) 这样不断增长的JPA/Repository 查询似乎不是一个解决方案......然后验证应该在几个查询中进行吗？包含所有父母的 ID 会使实际查询变得非常复杂。此外，标识符必须通过所有层（服务、安全）传递，这使内部 API 变得复杂。

Answer 1

简短的回答：是的，您必须检查父/根实体是否存在，是的，您需要定义实体之间的关系

长答案：

没有用户就无法创建帖子这一事实不必通过 URL 结构进行检查。该 URL 仅用于说明 请求什么资源。检查必须直接在代码中完成。检查记录的存在不需要额外的努力和方法，这是因为实体之间的关系。

在为用户添加帖子时，使用/users/{userId}/posts API，需要将帖子添加到id=[userId]的用户的帖子列表中，因此调用相关存储库方法获取用户记录（比如findById)，这本身就是用id=[userId]检查用户是否存在的行为。因为如果存储库返回 null，你就知道用户不存在

要设计好的、高效且易于理解的 API，请遵循以下简单规则：

如果资源可以单独访问，它必须有一个基本 URL 作为 /[entity]，否则使用父子模式（就像你的帖子一样）。

请注意，此规则并非一直有效，很多时候您需要自定义 API 并将其更改为更高效。

所以，如果一个用户可以看到其他用户的帖子，那么你应该设计这样的 API：

• /users [对用户实体的请求]
• /posts [帖子实体请求]

那么对于特定用户的帖子的请求，您应该使用/users/{userId}/posts创建新帖子或阅读它们，对于特定帖子的cmets您应该使用/posts/{postId}/comments。

据我了解您的应用程序的设计，您不需要/comments，因为所有 cmets 都与帖子相关，并且应该通过相关帖子访问（如上）。如果 cmets 可以单独访问（例如有一个页面列出所有 cmets 而无需关心其相关帖子），那么您需要/comments API 以获得更多说明