我們是否應該在POST響應中區分'回顯'請求字段？

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

個人而言，我不會區分請求字段，因爲它可能會比較混亂的開發者，它也需要你有一個正確的命名約定，以便你的字段名稱不會發生衝突。