Pagination in APIs ist das Aufteilen langer Ergebnislisten einer Schnittstelle in einzelne Seiten. Statt zehntausend Produkte auf einmal zu schicken, liefert die Schnittstelle etwa hundert und sagt, wie die nächsten zu holen sind.
- Pagination in APIs
Die seitenweise Auslieferung von Datensätzen durch eine Schnittstelle, gesteuert über Parameter wie Seitenzahl, Versatz oder Cursor.
Beispiel: „Der Import holt die Kundendaten über die Pagination in der API in Blöcken zu je hundert Datensätzen.“Verwandt: Pagination, die Aufteilung von Inhalten auf mehrere Seiten einer Website.
Verfahren der Pagination in APIs
Bei der Offset-Pagination gibst du an, wie viele Einträge übersprungen werden und wie viele kommen sollen, etwa ?offset=200&limit=100, oder einfach eine Seitenzahl. Das ist leicht zu verstehen und erlaubt den Sprung auf jede Seite.
Bei der Cursor-Pagination liefert jede Antwort eine Markierung für die nächste Seite mit, und die nächste Anfrage schickt diese Markierung zurück. Das bleibt auch bei sehr großen Datenmengen schnell und verschluckt keine Einträge, wenn währenddessen neue dazukommen.
Wie eine API die nächste Seite anzeigt
Entweder im Body der Antwort, mit Angaben wie Gesamtzahl, aktueller Seite und einem Link zur nächsten, oder im Header Link, wie es etwa die Schnittstelle von GitHub macht. Laravel liefert bei paginierten Abfragen beides von selbst.
Alle Seiten abrufen
Wer alle Datensätze braucht, ruft Seite um Seite ab, bis keine nächste mehr gemeldet wird. Dabei lohnt eine Pause zwischen den Anfragen, damit das Rate Limiting der Schnittstelle nicht greift.
Ein häufiger Fehler ist, nur die erste Seite zu verarbeiten. Bei kleinen Testdaten fällt das nicht auf, im Echtbetrieb fehlen dann plötzlich alle Einträge ab Nummer hundert.