Karate DSL ↔ REST API Pagination: Unresolved Built‑in Support

Answer

Karate DSL does not ship a built‑in pagination keyword or auto‑iterate feature; paged REST calls must be driven by manual loops in the test script.

Confirmed facts

• Karate’s core language (as of the latest released version) contains no keyword such as pagination, iteratePages, or similar.
• Users must implement pagination using Karate variables, while loops, and karate.appendTo (or karate.concat) to accumulate results.
• The safest way to detect the end of a paged result set is to rely on an explicit signal from the API: an empty content array, a missing next link, or a comparison of the retrieved offset/size against a total count field.

Recommended manual pattern

1. Define variables for the pagination parameters your API uses (e.g., offset, limit, page, size) and initialise them to the first‑page values.
2. Start a while (true) loop.
3. Inside the loop, call the endpoint with the current parameters, capture the response JSON.
4. Append the page’s data to an accumulator (e.g., karate.appendTo('allItems', response.content)).
5. Determine whether to continue:
   • If the response contains a total or totalElements field, break when offset + size >= total.
   • Otherwise, break when the page’s data array is empty (response.content.length == 0) or when a next link is absent.
6. Update the pagination variables for the next iteration (increase offset by size, or increment page).
7. End the loop.