小编典典

安静的 POST 响应的“最佳”实践

all

所以这里没有什么新东西我只是想得到一些澄清,似乎在其他帖子中找不到任何东西。

我正在重新创建一个新资源,比如说:

/books (POST)

有身体:

{
  title: 'The Lion, the Witch and the Wardrobe',
  author: 'C. S. Lewis'
}

我知道我应该返回一个 201(已创建),并带有新资源的 Location 标头:

Location: /books/12345

我似乎无法为自己回答的问题是服务器应该在正文中返回什么。

我经常做这样的回应:

{
  id: 12345,
  title: 'The Lion, the Witch and the Wardrobe',
  author: 'C. S. Lewis'
}

我这样做有几个原因:

  1. 我已经为 angularjs 等前端框架编写了 api。在我的特殊情况下,我使用的是角度资源,我经常只需要资源的 id 来定位它。如果我没有在响应正文中返回 id,我需要将其从 Location 标头中解析出来。
  2. 在所有书籍的 GET 中,我通常会返回整个对象,而不仅仅是 id。从这个意义上说,我的客户端代码不必区分从哪里获取 id(位置标头或正文)。

现在我知道我在这里真的处于灰色地带,但大多数人都说归还整个资源是“不好的”做法。但是,如果服务器更改/向资源添加信息怎么办。它肯定会添加
id,但也可能会添加其他内容,例如时间戳。在我不返回整个资源的情况下,执行 POST,返回 id,然后让客户端执行 GET 以获取新资源是否真的更好。


阅读 70

收藏
2022-05-13

共1个答案

小编典典

在更新时返回整个对象似乎不是很相关,但我几乎不明白为什么在创建时返回整个对象在正常用例中是一种不好的做法。这至少对于轻松获取 ID
并在相关时获取时间戳很有用。这实际上是使用 Rails 搭建脚手架时的默认行为。

我真的看不出只返回 ID 并在之后执行 GET 请求以获取您可以通过初始 POST 获得的数据的任何优势。

无论如何,只要您的 API 是一致的,我认为您应该选择最适合您需求的模式。没有任何正确的方法来构建 REST API,imo。

2022-05-13