REST API のベストプラクティス: クエリ文字列とリクエスト本文の引数 質問する

REST API のベストプラクティス: クエリ文字列とリクエスト本文の引数 質問する

休むAPI はいくつかの場所で引数を持つことができます:

  1. リクエスト本文 - JSON本文の一部として、または他のマイムタイプ
  2. の中にクエリ文字列- 例:/api/resource?p1=v1&p2=v2
  3. URLパスの一部として - 例:/api/resource/v1/v2

上記の 1 と 2 のどちらかを選択する場合のベスト プラクティスと考慮事項は何ですか?

2対3はカバーされていますここ

ベストアンサー1

上記の 1 と 2 のどちらかを選択する場合のベスト プラクティスと考慮事項は何ですか?

通常、コンテンツ本体はサーバーにアップロード/サーバーからダウンロードされるデータに使用され、クエリ パラメータは要求されたデータを正確に指定するために使用されます。たとえば、ファイルをアップロードするときは、本体に名前、MIME タイプなどを指定しますが、ファイルのリストを取得するときは、クエリ パラメータを使用して、ファイルのプロパティによってリストをフィルター処理できます。一般に、クエリ パラメータはデータではなく、クエリのプロパティです。

もちろん、これは厳密なルールではありません。自分にとってより適切/効果的と思われる方法で実装できます。

また、以下もチェックしてみてください。クエリ文字列に関するWikipediaの記事特に最初の 2 つの段落。

おすすめ記事