Webservice API 设计：仅返回显示类型或类型代码或两者兼而有之？

Question

Web 服务设计 - 我的 Web 服务应该如何响应？

例如电话号码可以有“家庭电话”、“商务电话”、“客户服务电话”等类型

我的 Web 服务 API 应该在响应中返回“PhoneTypeCode”还是 PhoneTypeName（用于显示）？

Example of Business telephone type

1) PhoneTypeCode: "business"
2) PhoneType: "Business telephone"
3) Return both?

Answer 1

根据您的需要，两种方法都可以。

决定时考虑：

• 如果客户对不同类型有特殊的处理 - 在这种情况下，代码会更容易处理。
• 如果存在本地化问题并且您的服务已经提供了本地化响应（即，您将数字/日期作为本地化字符串返回，或者您需要在请求中传递文化并且其他字符串相应地进行本地化）。如果您的服务器不提供任何本地化支持 - 重新返回字符串可能是错误的。
• 如果类型集完整 - 如果不将类型重新定义为字符串（非本地化）可能会更好，因为它会强制客户端更早地开始处理“未知”类型。