私たちが開発している 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'