POSTレスポンスの 'echoed'リクエストフィールドを区別する必要がありますか？

Question

私たちが開発しているWebアプリケーションは、開発者が開発したフォームからサーバーにHTTP POSTを行うことを可能にします。リクエストとレスポンスのフィールド名のAPIリファレンスを提供します。

私たちのアプリケーションの特定の要件の1つは、応答には、最初に送信されたすべての要求フィールドが含まれている必要があります。つまり、応答内の要求フィールドのエコーのようなものです。明確な直感的とを試してみて、APIを保つために

、私は、応答フィールド名に、我々は区別するために、何か（例えば「req_」や「request_」）を持つもの「こだま」リクエストフィールドを付加することを示唆しています真の応答データからのものです。しかし、このアプローチでは少数の人がそうは確かではなく、名前を同じにすることを提案しています。

私はこれについてあなたの意見をいただきたいと思います。私はAPIを定義するのが比較的新しいので、どんなフィードバックも素晴らしいでしょう。要約する

、テーブルの上に2つのオプションがあります。

オプション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

私はそれがために混乱するかもしれない可能性があるので、要求のフィールドを区別しません開発者は、フィールド名が衝突しないように、正しい命名規則を持つことも求められます。