ペイロードにリソースIDを含めるか、URIから派生するには

APIを設計する際に、PUTペイロードに更新対象のリソースのIDを含める必要があるかどうかという疑問に思いつきました。

これは私たちが現在持っているものです：

PUT /users/123 Payload: {name: "Adrian"}

ルートコードはURIからIDを抽出し、更新を続行します。

APIの最初のユーザーは、ペイロードにIDを許可しない理由を疑問視しています。

PUT /users/123 Payload: {id: 123, name: "Adrian"}

許可しなかった理由は、ペイロードとURIでIDが重複しているためです。

これについてもう少し考えて、リソースをURIに結合しています。

URIにIDがない場合、ペイロードを修正する必要があります。

PUT /no/id/here Payload: {name: "Adrian"} < What user???

しない理由はありますか？

あなたがされているはずのカップル統一へのリソースに識別子リソース。

RESTがHTTPで実装されている場合、GETを使用してリソースの現在の値を取得し、PUTを使用して新しい値を設定します。GETにはペイロードがないため、リソースはURIで識別する必要があります。そして、PUTは同じURIに対して論理的に行われ、ペイロードは次のGETが返すものとまったく同じに見えるはずです。

異なるURIに対してPOSTを使用できますが、GETに対して不必要に非対称であるため、あまり意味がありません。共通URIへのPOSTは、新しいリソース（POST /users/new、ペイロード：{name: "Adrian"}、応答{id: 345, name: "Adrian"}）を作成する場合にのみ意味がありますが、それはi等ではないため、避ける必要があります あなたがRESTを目指しているなら¹。代わりに、1回の呼び出しでIDを予約し、PUTを使用して新しいIDを設定する必要があります。これはフォールトトレラントです。最初の要求が失敗した場合、ID予約は最終的にタイムアウトになる可能PUT性があり、the 等であるためです。または、クライアントが生成したUUIDを使用します。

¹RESTの定義は、べき等については何も言及していないため、非べき等の操作がある場合、それがRESTであると実際に主張することはできません。それは、dem等の要求に固執することで、それらを複雑にすることなく物事をより信頼できるものにするという事実を変更しないため、推奨されます。

これについてもう少し考えて、リソースをURIに結合しています。

URIにIDがない場合、ペイロードを修正する必要があります。

PUT / no / id / hereペイロード：{名前： "エイドリアン"} <どのユーザー???

しない理由はありますか？

この質問に対する答えは、クライアントがIDを変更できるようにするかどうかによって異なりますか？

クライアントがPUTを介してIDを変更できる場合、リソースのURIが変更されるため、リソースが古いURIにアクセスするたびに301 Moved Permanentlyを指定する必要があります。

たとえば、次のリソースから開始します

/users/123

そして、クライアントはリソースに以下をPUTします

{id: 222, name: "Adrian"}

リソースが更新され、そのURIは現在

/users/222

LocationPUT応答のフィールドには新しいURIが含まれている必要があります。アクセスすると、Locationフィールドが新しいリソースを指して/users/123いる301応答が返されます/users/222。

ただし、ほとんどの場合、実際にクライアントがIDを変更できるようにすることは望ましくありません。この場合、IDはサーバーのみが変更できるものであり、クライアントはこの状態を更新できないため、PUT本体から除外する必要があります。

同じリソース上の異なるURIにrequireをPUTする場合、たとえば

/users/adian_lync

そのリソースが存在しない場合、サーバーはそれを作成し、実行中にIDを作成する必要があります