Pagination

{warning} Die brshop24 API hat den Status "Work in progress". Bei dieser Dokumentation handelt sich um einen Vorabzug zu Testzwecken.

Pagination ist dazu da, nur eine bestimmte Anzahl an Ergebnissen pro Abfrage zu erhalten. Dabei werden die Ergebnisse in mehrere Seiten aufgeteilt, die dann nacheinander abgerufen werden können.

• Einleitung
• Pagination in GraphQL

Pagination in GraphQL

In GraphQL gibt es keine vorgegebene Paginationsfunktion. Es ist aber möglich diese mit den Mitteln von GraphQL umzusetzen.

Umsetzung in der API

Dies ist in unserer API wie folgt umgesetzt:

Parameter für die Pagination sind:

• number: Nummer der anzuzeigenden Seite
• per_page: Anzahl der Ergebnisse pro Seite

Im Ergebnis werden die eigentlichen Daten dann im Feld data übergeben und es können noch einige Felder mit Paginations-Informationen abgefragt werden:

• total: Anzahl der Ergebnisse insgesamt
• per_page: Maximale Anzahl pro Seite
• current_page: Aktuelle Seite
• from: Nummer des ersten Datensatzes auf der Seite
• to: Nummer des letzten Datensatzes auf der Seite

Dadurch kann beispielsweise eine Pagination wie folgt dargestellt werden:

query pagination {
    pages (page:{number:1 per_page:10}) {
        total
        per_page
        current_page
        from
        to
        data {
            title
            body
        }
    }
}