データコレクションの操作

コレクションリソースは、Liferay DXPのWeb APIでは一般的です。先に紹介した、ポータルのblog-postingsのリソースURLにリクエストを送信する例に沿って操作を進めた場合、既にコレクションが動作しているのが確認できます。BlogPostingリソースがコレクションです。

ここでは、コレクションリソースの操作に関する詳細を説明します。そのためには、まず最初に、ページでコレクションがどのように返されるかについて解説する必要があります。

ページネーション

小さなコレクションは、1回の応答で簡単に送信できます。 ただし、大規模なコレクションを一度に送信すると、帯域幅、時間、およびメモリを大量に消費する可能性があります。また、大量のデータでユーザーを困らせてしまう可能性もあります。 したがって、大規模なコレクションは要素を個別のチャンク、またはページで取得して表示するのが最適です。

Liferay DXPのヘッドレスREST APIは、デフォルトでページ分割されたコレクションを返します。応答に含まれる以下の属性には、これらのページ間を移動するために必要な情報も含まれています。

totalCount:リソースのアイテムの総数。

pageSize:この応答に含まれるリソースのアイテム数。

page:現在のページの番号。

lastPage:最後のページの番号。

items:ページに存在するコレクションの要素。各要素には、それが表すオブジェクトのデータも含まれているため、個々の要素に対する追加のリクエストは必要ありません。

id:各アイテムの識別子。必要に応じてこれを使用することで、特定のアイテムに関する詳細情報を取得できます。

コレクションページの使用例については、Paginationを参照してください。

この記事は役に立ちましたか?
0人中0人がこの記事が役に立ったと言っています