API呼び出しのページネーション
項目のリストを返すエンドポイントを呼び出す場合、1回のレスポンスですべてのリストを取得できないことがあります。すべての項目を取得するには、ページを順に処理する必要があります。
このようなエンドポイントのレスポンスには、total_item_countとpage_item_limitプロパティを持つpagingオブジェクトが含まれます。「次」のページが利用可能な場合、next「アンカー」項目も含まれます。たとえば、レスポンスには次のページの最初のアプリのアプリスラッグが表示されます。
{
"data": [ ... ],
"paging": {
"total_item_count": 3,
"page_item_limit": 2,
"next": "518e869d56f2adfd"
}
}
pagingオブジェクトのnextプロパティpagingオブジェクトのnextプロパティは、次のページが1つ以上ある場合にのみ含まれます。paging内にnextプロパティがない場合、それ以上取得できるページがないことを意味します。
limitパラメーターを使用して、レスポンスのページ数を制限します。
https://api.bitrise.io/v0.1/apps?limit=10
この呼び出しでは、page_item_limitプロパティを10に設定します。パラメーターのデフォルト値(および最大値)は50です。
レスポンス項目を順に処理する:
- パラメーターを指定せずにエンドポイントを呼び出します。
- レスポンスから
pagingオブジェクトを処理します。 pagingオブジェクトにnext項目が含まれている場合は、next=クエリパラメーターを追加して同じエンドポイントを呼び出し、レスポンスで取得した値をnextパラメーターの値として渡します。
-
https://api.bitrise.io/v0.1/appsを呼び出します。 -
項目(
dataプロパティ)を処理します。 -
paging(ルート)プロパティを確認します。 -
paging内にnextプロパティがある場合は、nextクエリパラメーターを指定してエンドポイントを再度呼び出します- 例:
https://api.bitrise.io/v0.1/apps?next=NEXTVALUE。ここでNEXTVALUEは、直前のレスポンスで取得したnextプロパティの値です。
- 例:
-
pagingオブジェクトにnextプロパティが含まれなくなるまでこれを繰り返します。含まれなくなった時点で、受け取ったページが最後のページであることを意味します。