7. ページネーション¶

API での集合の応答は、画面単位で出力されます。つまり、集合には数十万のオブジェクトが含まれる可能性がありますが、各ウェブリクエストでは、API のパフォーマンスのために、一定数の結果しか返されないことになります。

返される結果は以下のようになります。

{'count': 25, 'next': 'http://testserver/api/v1/some_resource?page=2', 'previous': None, 'results': [ ... ] }

次のページに進むには、next の次にある URL をリクエストします。

各リクエストで返される結果の数を変更するには、page_size=XX クエリー文字列パラメーターを使用します。

特定のページの結果を取得するには、page クエリー文字列パラメーターを使用します。

http://<Tower server name>/api/v1/model_verbose_name?page_size=100&page=2

結果で返される previous および next のリンクは、これらのクエリー文字列パラメーターを自動的に設定します。

シリアライザーは効率的ですが、200 を超えるサイズのページはリクエストしない方がよいでしょう。

ユーザーがスクロールで苦慮しないように、ユーザーインターフェイスでは小さい値を使用します。