向现有 REST-api 添加元素

Question

将元素添加到来自 api 的响应是否被认为是好的做法？

如果现有响应如下所示：

{
"Animal": "Dog", 
"nrOfZoomsADay": 300
}

如果将元素添加到此已使用的 REST 客户端响应中，是否会被视为良好做法？ 还是应该创建一个新端点？ 请记住，这是一个旧端点，您无法控制用户。

{
"Animal" : "Dog", 
"nrOfZoomsADay": 300,
"lastSeen": "Couch",
"favoriteToy: "Teddy Bear"
}

Answer 1

首先，API 映射/请求方法是什么？ 响应中新添加的属性是否有意义，客户是否希望将它们包含在响应正文中？

通常，如果您是唯一使用 API 方法的客户端（例如带有 REST 后端的 Web 应用程序），那么修改响应主体没有问题，因为您可以在客户端对其进行调整。

如果您有您不认识并且无法控制的客户，那么您应该确保您的 API 响应修改不会破坏他们当前正在运行的程序。 在您的情况下，向响应主体添加新属性不会破坏它们的功能，例如删除现有属性，因此这不应该成为问题。 他们会自动忽略新添加的属性。 唯一的缺点是更多的流量。