0

我们正在开发的 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'
4

1 回答 1

0

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

于 2012-05-08T10:23:11.507 回答