API呼び出しのページ付け
Bitrise APIを使用すると、ページ付けを使用して、特定のエンドポイントの応答内のアイテムのリストを反復処理できます。ページ付けのプロパティを構成できます。
アイテムのリストを返すエンドポイントを呼び出すと、単一の応答でリスト全体を取得できない場合があります。すべてのアイテムを取得するには、ページを反復処理する必要があります。
このようなエンドポイントの応答には、 paging オブジェクト、と total_item_count と page_item_limit プロパティ。利用可能な「次の」ページがある場合は、 next 「アンカー」アイテム。たとえば、応答には、次のページの最初のアプリのアプリスラッグが表示されます。
{
"data": [ ... ],
"paging": {
"total_item_count": 3,
"page_item_limit": 2,
"next": "518e869d56f2adfd"
}
}
NS next のプロパティ paging 物体
NS next のプロパティ paging オブジェクトは、使用可能なページが少なくとも1つある場合にのみ含まれます。ない場合 next 内部のプロパティ paging つまり、取得するページがこれ以上ないということです。
で応答ページの数を制限します limit パラメータ:
https://api.bitrise.io/v0.1/me/apps?limit=10
この呼び出しは、 page_item_limit プロパティを10に設定します。パラメータのデフォルト(および最大)値は50です。
応答項目を繰り返します。
-
ページ付けパラメーターなしでエンドポイントを呼び出します。
-
応答プロセスから
paging物体。 -
の場合
pagingオブジェクトには、nextアイテム、追加でまったく同じエンドポイントを呼び出すnext=パラメータをクエリし、応答で取得した値をの値として渡しますnextパラメータ。
-
電話
https://api.bitrise.io/v0.1/me/apps。 -
アイテムを処理します(
data財産)。 -
確認してください
paging(ルート)プロパティ。 -
ある場合
next内部のプロパティpaging、エンドポイントを再度呼び出します。nextクエリパラメータ-
例:
https://api.bitrise.io/v0.1/me/apps?next=NEXTVALUE、 どこNEXTVALUEの値ですnext以前の応答で取得したプロパティ。
-
-
までこれを繰り返します
pagingオブジェクトには含まれていませんnextプロパティ。これは、受け取ったページが最後のページであることを意味します。