ページネーション
API はエンドポイントに応じて 2 種類のページネーション方式を使用します。
オフセットページネーション
クエリパラメーターとして page を渡してください(デフォルト 1、最大 100)。1 ページあたり最大 25 件のアイテムが返されます。
bash
curl 'https://api.youvico.com/api/projects/:id/versions?page=2' \
-H 'Authorization: Bearer YOUR_API_KEY'json
{
"data": [...],
"page": {
"current": 2,
"hasNext": true
}
}hasNext が true の場合は page をインクリメントして次のページを取得してください。
カーソルページネーション
各レスポンスには next と prev カーソルが含まれます。次のリクエストでいずれかを渡すと、前後のページに移動できます。
json
{
"data": [...],
"page": {
"next": "MjAyNi0wNC0xMFQwODowMDowMC4wMDBa",
"prev": null
}
}- カーソルが
nullの場合、その方向にはこれ以上結果がありません。 - 1 回のリクエストで
nextまたはprevの いずれか一方のみ を送信してください。両方を送ると400エラーになります。 - カーソルの値は不透明な文字列として扱ってください。解析や自作は行わないでください。
bash
curl 'https://api.youvico.com/api/versions/:id/comments?next=MjAyNi0wNC0xMFQwODowMDowMC4wMDBa' \
-H 'Authorization: Bearer YOUR_API_KEY'