検索のページ件数と取得上限を設定する

1. このページで伝える機能

一覧検索で1ページに取得する標準件数と、1回の検索で要求できる最大件数を共通設定として決められます。検索条件や表示列の設定と合わせて、利用者が確認しやすい件数にします。

2. Wagby11で実現できること

2.1 標準件数と上限を分ける

標準件数は、検索時に件数を指定しなかった場合の値です。上限は、1回の検索で要求できる最大件数です。例えば標準20件・上限100件なら、通常は20件ずつ取得し、件数を指定する検索でも100件まで受け付けます。検索結果全体を100件に切り捨てる設定ではありません。

2.2 上限を超える要求を受け付けない

検索APIのsizeは1以上、最大ページ件数以下で指定します。範囲外は400エラーになります。標準件数と上限はいずれも正の整数とし、標準件数を上限以下にします。生成されるOpenAPIの件数上限も、この定義に従います。

件数を増やす場合は、一覧の読みやすさと応答時間を確認します。検索条件の設定や一覧表示と一覧更新の操作を変える設定とは分けて考えます。

実行時にwagby.pagination.max-page-sizeを上書きした場合、入力チェックはその値を使います。定義と実行設定に差がある場合は、生成された契約も含めて確認します。

2.3 モデルごとの検索設定との関係

標準ページ件数と最大取得件数はアプリケーション共通です。モデルごとのAppSchemaに別のページ件数・上限を指定する設定はありません。各モデルの検索には、この共通設定を使います。検索APIを呼び出す場合は、共通の上限内で要求ごとにsizeを指定できます。これはモデル別の既定値とは異なります。

モデルごとの検索条件・一覧列・並び順は、検索条件を設定するを参照してください。

3. AIへの指示例

最小限の指示例

検索は通常20件ずつ表示し、1回に要求できる件数は100件までにしてください。

AIは既存のページ件数、検索画面とAPIの使われ方、反映のための生成・起動手順を確認します。総件数の制限か1ページの制限かを明確に伝えます。短い指示だけで、次の詳細例と同じ設定になるとは限りません。

より詳細な指示例

Wagby11のguideと必要なreferenceを確認してください。
environment.paginationのdefault_page_sizeを20、max_page_sizeを100にしてください。
size省略時が20件、size=100が受理され、size=0とsize=101が400となることを確認してください。既存の検索条件、表示列、権限を保持してください。
既存のenvironment全体を置き換えず、必要な項目を編集してください。設定の検証・生成と必要なサービスの再起動を行い、変更内容と確認結果を説明してください。

4. 編集されるAppSchemaの例

次は共通設定の抜粋です。設定名を覚えなくても、必要な動作や上限をAIへ伝えられます。既存のenvironment内へ追加・編集し、他の共通設定を保持します。

environment:
  pagination:
    default_page_size: 20
    max_page_size: 100

5. 参考資料

guide：環境

designer/docs/appschema/html/guide/02-environment/01-appschema-environment.html

reference：AppSchema全体構成

designer/docs/appschema/html/reference/02-root-schema.html