rest - この REST API のパラメータ値はどこにあるべきですか? またその理由は?

Question

次の REST API があります。

POST /users/martin/notify/...

API は、ユーザー Martin が何か言いたいことをユーザーのリストに通知すると想定されています。通知されるユーザーのリストは、1 人から 1,000 人までさまざまです。1,000 人のユーザーのリストはどこにあるべきか: クエリ文字列、HTTP ヘッダー、またはリクエスト本文? なんで？

Answer 1

リクエスト本文。多くの場合、ヘッダーとクエリ文字列には、実際にはサイズ制限があり、1,000 個の識別子で間違いなくヒットします。より理論的なレベルでは、リクエストの本文は、サーバーに POST 経由で処理させたいエンティティである必要があります。ヘッダーは、そのエンティティに関するプロトコル レベルのメタデータ用です。つまり、エンティティの処理に役立つ情報ですが、エンティティ自体には役立ちません。クエリ文字列はリソースの識別子の一部であり、そのリソースの表現でもありません。