Skip to main content

API呼び出しのページ付け

概要

Bitrise APIを使用すると、ページ付けを使用して、特定のエンドポイントの応答内のアイテムのリストを反復処理できます。ページ付けのプロパティを構成できます。

アイテムのリストを返すエンドポイントを呼び出すと、単一の応答でリスト全体を取得できない場合があります。すべてのアイテムを取得するには、ページを反復処理する必要があります。

このようなエンドポイントの応答には、 paging オブジェクト、と total_item_countpage_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です。

応答項目を繰り返します。

  1. ページ付けパラメーターなしでエンドポイントを呼び出します。

  2. 応答プロセスから paging 物体。

  3. の場合 paging オブジェクトには、 next アイテム、追加でまったく同じエンドポイントを呼び出す next= パラメータをクエリし、応答で取得した値をの値として渡します next パラメータ。

例1 登録済みのすべてのアプリを繰り返し処理します
  1. 電話 https://api.bitrise.io/v0.1/me/apps

  2. アイテムを処理します(data 財産)。

  3. 確認してください paging (ルート)プロパティ。

  4. ある場合 next 内部のプロパティ paging、エンドポイントを再度呼び出します。 next クエリパラメータ

    • 例: https://api.bitrise.io/v0.1/me/apps?next=NEXTVALUE、 どこ NEXTVALUE の値です next 以前の応答で取得したプロパティ。

  5. までこれを繰り返します paging オブジェクトには含まれていません next プロパティ。これは、受け取ったページが最後のページであることを意味します。