1. ホーム
  2. rest

[解決済み] オブジェクト内のアイテムの合計数を返すための最良のRESTfulメソッドは何ですか?

2022-04-22 18:44:15

質問

私が関わっている大規模なソーシャルネットワーキングサイトのREST APIサービスを開発しています。今のところ、それは素晴らしい動作をしています。私は以下を発行することができます GET , POST , PUTDELETE リクエストをオブジェクト URL に送信し、私のデータに影響を与えます。しかし、このデータはページングされています(一度に30件の結果に制限されています)。

しかし、私のAPIを介して、例えばメンバーの総数を取得するための最良のRESTfulな方法は何でしょう?

現在、以下のようなURL構造でリクエストを発行しています。

  • /api/members -メンバーのリストを返します (上記のように一度に30人です)
  • /api/members/1 -使用されるリクエストメソッドに応じて、単一のメンバーに影響します。

質問は、同様のURL構造を使用して、アプリケーションのメンバーの総数を取得するにはどうすればよいかということです。明らかに id フィールド(FacebookのグラフAPIに似ている)と結果を数えることは、30件の結果の一部しか返されないことを考えると、効果的ではないでしょう。

解決方法は?

API/usersへのレスポンスはページングされ、30件のレコードのみを返しますが、レスポンスにレコードの総数や、ページサイズ、ページ番号/オフセットなどのその他の関連情報を含めることを妨げるものは何もありません。

StackOverflow APIは、それと同じ設計の良い例です。以下は、Usersメソッドのドキュメントです。 https://api.stackexchange.com/docs/users