我们应该在POST响应中区分“echoed”请求字段吗？

Question

我们正在开发的Web应用程序允许开发人员从表单（他们开发）到我们的服务器进行HTTP POST。我们为它们提供了请求和响应字段名称的API参考。

我们的应用程序的一个特殊要求是响应必须包括最初提交的所有请求字段 - 有点像响应中请求字段的回显。

为了尝试保持API 直观和明确，我建议在响应字段名称中，我们将这些“回显”请求字段添加到某些内容中（例如' req_'或'request_'）将它们与真实的响应数据区分开来。然而，有些人不太确定这种方法，他们建议我们保持名称相同。

我很感激你对此的看法;我对定义API相对较新，所以任何反馈都会很棒。

总而言之，表格中的两个选项是：

选项1 - 不区分响应中的请求字段

请求：

name: 'Joe Bloggs'
address: '22 My Street, My City'
amount: '100.00'

响应：

transaction_id: '384765'
transaction_time: '2011-12-31T11:59:59Z'
message: 'Your transaction was successful.'
name: 'Joe Bloggs'
address: '22 My Street, My City'
amount: '100.00'

选项2 - 区分响应中的请求字段

请求：

name: 'Joe Bloggs'
address: '22 My Street, My City'
amount: '100.00'

响应：

transaction_id: '384765'
transaction_time: '2011-12-31T11:59:59Z'
message: 'Your transaction was successful.'
req_name: 'Joe Bloggs'
req_address: '22 My Street, My City'
req_amount: '100.00'

Answer 1

就个人而言，我不会区分请求字段，因为它可能会让开发人员感到困惑，它还需要您具有正确的命名约定，以便您的字段名称不会发生冲突。