向現有 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 響應修改不會破壞他們當前正在運行的程序。 在您的情況下，向響應主體添加新屬性不會破壞它們的功能，例如刪除現有屬性，因此這不應該成為問題。 他們會自動忽略新添加的屬性。 唯一的缺點是更多的流量。