RESTful API を作成するときは、クライアントにオブジェクト名または属性のみを送信させる方が適切です。たとえば、POST /people/の本文:
オプション 1: {person: name: 'John'}
オプション 2: {name: 'John'}
通常、ほとんどの API でオプション 2が表示されますが、問題が発生しています。私は Rails を使用しているので、html と json の両方のリクエストを処理するアクションが必要な場合は、オプション 1を使用する必要はありません(Rails フォームはオブジェクト タイプで始まるパラメーターを送信するため)。
あるオプションと他のオプションの長所/短所はありますか?
ほとんどの{person: {name: 'John'}}場合、送信は不要です。POST や GET を行っている場合は、通常、URL に基づいて、期待または送信する応答のタイプ (この場合は「人」) がわかるからです。
ただし、オプション 1 には使用例があります。オプション 2 を使用すると、入力情報を取得するために GET や POST を実行している URL に依存しています。これは JSON で明示的に宣言されていません。/service/person/{id}から GET すると、「person」タグ{person: {name: 'John'}}が冗長になるので、これは良いことです。ただし、ペイロードを検証するために POST するサービスなど、より RPC に/service/validate似たサービスがある場合は、サービスがタイプを判断できるように、その追加情報が必要になる場合があります。