Ressourcen · 86

API-Paginierung: Exporte ohne fehlende oder doppelte Datensätze

Reihenfolge, Token, Berechtigungen und Wiederaufnahme bei veränderlichen Sammlungen festlegen.

Aktualisiert · 3 min

Laptop mit Programmcode auf einem Schreibtisch Illustration · fiktive Szene

Wozu dieser Leitfaden beiträgt

  • Reihenfolge und Umfang festlegen
  • Token als Fortsetzung behandeln
  • Ende aus dem Vertrag ableiten
  • Nach Fehlern fortsetzen
  • Ergebnis abgleichen

Kurzcheck

  • Bedeutet eine leere Seite das Ende?
  • Kann ein Cursor Zugriffsrechte verleihen?
  • Verhindert Deduplizierung fehlende Datensätze?

Schritt-für-Schritt-Anleitung

  1. 1

    Reihenfolge und Umfang festlegen

    Dokumentieren Sie Filter, Reihenfolge und einen Schlüssel zur eindeutigen Sortierung. Ein Zeitstempel genügt nicht immer, wenn mehrere Objekte ihn teilen. Entscheiden Sie zwischen laufender Sammlung und festem Datenstand. Versprechen Sie keine unveränderliche Sicht ohne entsprechende Anbietergarantie.

    Ergebnis: Vertrag für Reihenfolge und Konsistenz.

  2. 2

    Token als Fortsetzung behandeln

    AIP-158 sieht opake Token vor und trennt Paginierung von Berechtigung: Ein Token gewährt keinen Zugriff. Prüfen Sie Identität und Rechte bei jeder Anfrage. Behalten Sie vertraglich gebundene Parameter bei und behandeln Sie Ablauf oder Ungültigkeit ausdrücklich.

    Ergebnis: gültige, abgelaufene und unberechtigte Tokenfälle.

  3. 3

    Ende aus dem Vertrag ableiten

    Nehmen Sie nicht an, dass eine kurze Seite die letzte ist. Eine API kann weniger Einträge und trotzdem eine Fortsetzung liefern. Nach AIP-158 kennzeichnet ein leeres next_page_token das Ende; passen Sie den Client an den tatsächlichen Anbieter an. Erkennen Sie wiederholte Token ohne Fortschritt.

    Ergebnis: Tests für Abschluss und Schleifen.

  4. 4

    Nach Fehlern fortsetzen

    Speichern Sie die Fortsetzung nach dauerhafter Ablage des Stapels. Entfernen Sie Duplikate anhand stabiler Kennungen und trennen Sie Wiederaufnahmestand von angezeigten Summen. Bei abgelaufenem Datenstand starten Sie neu oder gleichen nach festen Regeln ab; verbinden Sie nicht unbemerkt unterschiedliche Zustände.

    Ergebnis: Prüfpunkt und Ausfallszenario.

  5. 5

    Ergebnis abgleichen

    Vergleichen Sie eindeutige Kennungen, Ausschlüsse, Zustände und mögliche Referenzsummen zum gleichen Stichtag. Testen Sie Anlage, Änderung und Löschung während des Lesens. Eine passende Anzahl beweist nicht die richtigen Objekte. Schützen Sie Dateien und Protokolle entsprechend ihrer Daten.

    Ergebnis: Exportmanifest und dokumentierte Unterschiede.

Eine wiederaufnehmbare paginierte Abfrage

Bei einem Vertrag nach dem AIP-158-Muster bestimmt die Fortsetzung den nächsten Schritt. Eine kurze Seite beweist keinen Abschluss.

  1. Abfrage festlegen

    Filter, Reihenfolge, Parameter und berechtigte Identität bewahren.

  2. Stapel speichern

    Objekte und Kennungen dauerhaft ablegen.

  3. Fortsetzung folgen

    Ein vorhandenes Token führt zur nächsten Anfrage mit gebundenen Parametern.

  4. Am Ende abgleichen

    Bei leerem abschließendem Token Ausschlüsse, Referenzzustand und Abdeckung prüfen.

Fiktives Beispiel: Nach Stapelspeicherung fällt die Verbindung aus. Wiederaufnahme nutzt den Prüfpunkt und prüft schon verarbeitete Kennungen.

Wiederverwendbares Arbeitsblatt

Ergänzen Sie Ihre autorisierten Beobachtungen. Bei diesen Feldern handelt es sich um eine Arbeitsvorlage, nicht um beobachtete Ergebnisse.

FeldZu erfassende Informationen
SammlungFilter, Reihenfolge, eindeutiger Sortierschlüssel und Garantien
FortsetzungToken, gebundene Parameter, Ablauf und Ende
WiederaufnahmeDauerhafter Stapel, eindeutige Kennungen und Prüfpunkt
ErgebnisManifest, Ausschlüsse, Stichtag und Unterschiede

Fiktives Arbeitsbeispiel

Beispielhafte Situation

Fiktives Beispiel: Während eines Offset-Exports werden Produkte hinzugefügt und ein Datensatz verschiebt sich zwischen Seiten.

Entscheidung und erwartete Beweise

Der Test findet ein Duplikat und ein fehlendes Produkt; das Team nutzt einen verfügbaren Snapshot oder dokumentiert eine laufende Abfrage mit Abgleich.

Unterscheiden Sie die Mechanismen

MechanismusZweckÜberprüfung oder Einschränkung
OffsetNumerische Position ansteuernEinfügungen können Positionen verschieben
CursorVon einem Lesemarker fortsetzenGarantiert keinen festen Datenstand
SnapshotReferenzzustand festlegenGültigkeitsdauer und Kosten prüfen

Managementindikatoren

IndikatorWas es misstErste Aktion
Eindeutige KennungenUnterschiedliche exportierte ObjekteMit gleicher Referenz vergleichen
FortschrittTatsächlich fortschreitende Token und StapelSchleifen beenden und untersuchen
Geprüfte AbdeckungMit Referenzzustand abgeglichene ObjekteMenge nicht mit Vollständigkeit gleichsetzen

Häufige Fallstricke

  • Einfügungen können Positionen verschieben
  • Garantiert keinen festen Datenstand
  • Gültigkeitsdauer und Kosten prüfen

Häufig gestellte Fragen

Bedeutet eine leere Seite das Ende?

Prüfen Sie Vertrag und Fortsetzungstoken. Die Seitengröße allein darf nicht entscheiden.

Kann ein Cursor Zugriffsrechte verleihen?

Nein. Der Server prüft Rechte unabhängig vom Paginierungstoken.

Verhindert Deduplizierung fehlende Datensätze?

Nein. Sie entfernt Wiederholungen, aber findet nie gelesene Objekte nicht. Prüfen Sie stabile Reihenfolge und Änderungen.

Offizielle Referenzen

Die Referenzen unterstützen die Methode. Passen Sie die Prüfungen an Ihren Kontext an; sie stellen keine Zertifizierung dar. Originalreferenztitel und Quelldokumente können in einer anderen Sprache verfasst sein.

Referenzen geprüft am .