RESTful API代表没有东西

想象一下一个API，以确定一个人是否选择了他们的精神动物。他们只能有零个或一个精神动物。

目前：

/person/{id}/selectedSpiritAnimal

当他们选择了动物时，返回http 200， {selectedAnimal:mole}

但是当他们没有选择时，它将返回http 404。

这使我的精神动物不满意，因为我们正在表示一个有效的域问题-尚未选择精神动物-作为HTTP错误。

另外，作为一家公司-erm Sprit-Animal-Hampers-R-us，我们想知道某人何时没有选择，以便我们提示他们。

什么是更好的回应：

HTTP 200和 {selectedAnimal:null}

甚至更明确

HTTP 200和 {selectedAnimal:null, spiritAnimalSelected: false}

还是返回404更好？因为很像this image has not yet been uploaded在线查看图像时将是404。this person has not selected a spirit animal可能是404

该问题已被提议作为重复项，但是当应用程序配置为不允许该URL表示更改时，该问题解决了一个其他有效的URL。

而在这里，我正在研究在没有资源的情况下有意义的代表资源的方式。也就是说，客户端请求URL是有效的，并且响应是您已成功请求表示没有东西的资源。

因此，这不是“业务逻辑”，而是情况下缺少某物有意义（可能是因为我的许多同事都认为404仍然正确），但是我不确定如何将其映射到规格

很难选择答案。我在这里的谈话和正在进行的工作中多次改变主意。

在这里为我解决的问题是，规范指出4xx是客户犯错的时间。在这种情况下，已告知客户端期望来自selectedSpiritAnimal url的响应，因此不会出错。

我的同事之间的共识是，这是API设计错误的征兆

最好只请求/ person / {id}并返回该人的一组链接关系...那么如果没有给您/ selectedSpiritAnimal链接（当一个人没有选择时），但是您不管怎样都称它为404才有意义。或者您实施部分响应并让/ person / {id}返回更完整的文档，除非客户端请求数据的子集

对于这种情况，HTTP 4xx代码可能不是正确的选择。您声明精神动物为零是有效状态，API路由person/{id}/selectedSpiritAnimal将说明人是否id有一个。

当客户端在请求中做了一些不正确的情况时，将保留HTTP 4xx响应（请参阅w3的原始规范档案）。但是，无论人id是否有精神动物，客户都在发出有效的请求。

因此，我倾向于在响应中使用正确格式的JSON正文和HTTP 2xx代码来获取第二种解决方案。

现在，如果您收到这样的请求，结果发现人员id不存在，那么使用4xx代码更有意义。

让我向您介绍理查森成熟度模型。

您的问题是您将两个资源表示为一个，实际上您应该拥有两个具有超媒体指示关系的资源。使用超媒体来描述关系是Rest的辉煌3级。

您的人应该住在URI下，/person/{id}而动物应该住在URI 下/spiritanimal/{id}。该人应通过使用动物链接来表明它有精神动物。

假设有一个叫Bob的人，他的ID为123，是独角兽精神动物。

GET /person/123

会回来；

{
  "name": "Bob",
  "links": [
    {
      "rel": "spiritanimal",
      "uri": "/spiritanimals/789"
    }
  ]
}

现在，任何阅读123人的人都将知道他们有一只精神动物，并且拥有URI，可以在其中获取更多信息。

GET /spitiranimal/789

可能会回来

{
  "type": "Unicorn"
}

现在让我们想象一个叫Fred的人，他的ID为456，并且没有精神动物。

GET /person/456

会回来；

{
  "name": "Fred",
  "links": [
  ]
}

现在，任何读456人的人都会知道，他们没有灵性动物，因为没有联系。无需使用任何HTTP状态代码来表示缺少关系。

这是获取精神动物的合适网址；因此，404错误是不合适的。404用于表示技术问题，而不是逻辑问题。

适当的解决方案是返回http 200和 {"selectedAnimal": null}

您应该有一个单独的 web /person/{id}/hasSelectedSpiritAnimal方法返回{"isSpiritAnimalSelected": false}。在后台，它可能会或可能不会进行相同的方法调用，如果为null，则仅返回false，但这取决于它来决定，而不是由消耗代码决定。

最好避免在没有令人信服的理由的情况下将多个查询组合成一个Web方法，即使查询紧密相关。

端点代表的不仅仅是动物。这是动物还是动物。这是一个最好用Optional/ Maybe/ Nullable/等表示的值。

因此合法值（如200 OK）可能是：

• {'animal': <some animal>, 'selected': true}
• {'animal': null, 'selected': false}

我可以想象该DELETE方法在应用于端点时可以再次设置'selected'为false，即未设置选定的动物。

当然，您可以将'selected'密钥放在此处，仅为了说明而显示。字符串vs null足以区分。

您应该使用404。

404（未找到）状态代码表示原始服务器未找到目标资源的当前表示形式

RFC7231

HTTP/1.1 200 OK
Content-Type: application/json
Date: Mon, 25 Sep 2017 00:00:00 GMT

"mole"

HTTP/1.1 404 Not Found
Content-Type: text/plain
Date: Mon, 25 Sep 2017 00:00:00 GMT

this person has not selected a spirit animal

由于您是在编写程序界面而不是人机界面，因此404文本是可选的。

我之所以这样，是因为我尽可能地喜欢标准协议。HTTP有一种表示不存在的方式，这就是我要使用的方式。

编辑：假设您添加了一个功能，用户可以选择是否共享他们的精神动物，而没有人共享。您会返回200 OK null还是200 OK "Unauthorized？还是使用标准的401未经授权/ 403禁止使用？这似乎直接类似于不首先选择一个。

另外，如果要使用200 OK + JSON，则应返回null。

HTTP/1.1 200 OK
Content-Type: application/json
Date: Mon, 25 Sep 2017 00:00:00 GMT

"mole"

HTTP/1.1 200 OK
Content-Type: application/json
Date: Mon, 25 Sep 2017 00:00:00 GMT

null

保持清洁。仅在必要时创建更多包装。