将元素添加到现有 REST-api
Add elements to existing REST-api
将元素添加到 api 的响应中是否被认为是好的做法?
如果现有响应如下所示:
{
"Animal": "Dog",
"nrOfZoomsADay": 300
}
如果将元素添加到此随时可用的 REST 客户端响应中,是否会被视为良好做法?还是应该创建一个新端点?请记住,这是一个旧端点,您无法控制用户。
{
"Animal" : "Dog",
"nrOfZoomsADay": 300,
"lastSeen": "Couch",
"favoriteToy: "Teddy Bear"
}
首先,什么是API-mapping/request-method?响应中新添加的属性是否有意义,客户是否希望将它们包含在响应正文中?
一般来说,如果您是唯一使用您的 API 方法的客户(例如带有 REST 后端的 Web 应用程序),那么修改响应主体没有问题,因为您可以在您的客户上对其进行调整边.
如果您有您不认识的客户并且无法像您所说的那样控制,您应该确保您的 API 响应修改不会破坏他们当前的工作程序。在您的情况下,向响应主体添加新属性不会破坏它们的功能,例如删除现有属性,因此这不应该成为问题。他们会自动忽略新添加的属性。唯一的缺点是流量比较大。
将元素添加到 api 的响应中是否被认为是好的做法?
如果现有响应如下所示:
{
"Animal": "Dog",
"nrOfZoomsADay": 300
}
如果将元素添加到此随时可用的 REST 客户端响应中,是否会被视为良好做法?还是应该创建一个新端点?请记住,这是一个旧端点,您无法控制用户。
{
"Animal" : "Dog",
"nrOfZoomsADay": 300,
"lastSeen": "Couch",
"favoriteToy: "Teddy Bear"
}
首先,什么是API-mapping/request-method?响应中新添加的属性是否有意义,客户是否希望将它们包含在响应正文中?
一般来说,如果您是唯一使用您的 API 方法的客户(例如带有 REST 后端的 Web 应用程序),那么修改响应主体没有问题,因为您可以在您的客户上对其进行调整边.
如果您有您不认识的客户并且无法像您所说的那样控制,您应该确保您的 API 响应修改不会破坏他们当前的工作程序。在您的情况下,向响应主体添加新属性不会破坏它们的功能,例如删除现有属性,因此这不应该成为问题。他们会自动忽略新添加的属性。唯一的缺点是流量比较大。