Paginieren über HTTP-Aufrufe

Im folgenden Tutorial wird veranschaulicht, wie die Aktivität Do While verwendet wird, um die API-Paginierung zu verarbeiten, indem wiederholte HTTP-Aufrufe ausgeführt werden, bis alle Daten abgerufen sind.

Paginierungsindikatoren wie Cursor, Seitenende-Flags oder Grenzwerte sind in der Regel in den Antwortheadern, im Antworttext oder als Abfrageparameter enthalten.

In diesem Beispiel wird eine Liste von Browsern mithilfe der OpenBreweryDB -API abgerufen. Gemäß der OpenBreweryDB-API-Spezifikation wird die Paginierung mit Offset-basierten (seitenbasierten) Parametern behandelt. Um das Dataset zu paginieren, fügen Sie per_page=X&page=Y als Abfrageparameter in die HTTP-Anforderung ein.

1. Erstellen Sie einen API-Workflow.

2. Fügen Sie eine HTTP- Aktivität hinzu und konfigurieren Sie sie wie folgt:

   • Methode– GET
   • Anforderungs-URL–

     https://api.openbrewerydb.org/v1/breweries?per_page=10&page=1
     

3. Debuggen Sie Ihren API-Workflow, um die erste Auflistung von Browsern abzurufen.

4. Fügen Sie eine Script- Aktivität hinzu und geben Sie den folgenden Code an:

   const url = new URL($input.request.url);
   const currentPage = Number(url.searchParams.get("page"));
   
   return { nextPage: currentPage + 1, 
   content: $input.content}
   

   Die Verwendung von $input anstelle von $context stellt sicher, dass Sie immer auf die Ausgabe der zuletzt ausgeführten Aktivität verweisen, insbesondere innerhalb eines Schleifenblocks. Der JavaScript-Code gibt ein JSON-Objekt mit den Eigenschaften „nextPage“ und „content“ zurück. Mit diesen Eigenschaften können Sie die Schleife steuern, z. B.: fortfahren, während nächstePage < 10 ist oder der Inhalt nicht null ist.

5. Fügen Sie eine Loop > Do While- Aktivität über der vorhandenen HTTP- Aktivität hinzu.

   1. Verschieben Sie sowohl HTTP- als auch Script- Aktivitäten in den Do While- Aktivitätstext.
   2. Legen Sie die Bedingung für die Aktivität Do while auf $input.nextPage < 5 fest.
   3. Öffnen Sie für die Aktivität HTTP den Ausdrucks-Editor der Eigenschaft Anforderungs-URL und aktualisieren Sie den Ausdruck auf:

      "https://api.openbrewerydb.org/v1/breweries?per_page=10&page=" + ($input.nextPage == null ? 1 : $input.nextPage)
      

6. Debuggen Sie Ihren Workflow erneut und sehen Sie das Ergebnis-Array auf der Registerkarte Ausgabe des Bereichs Ausführungsausgabe .

7. Fügen Sie außerhalb der Aktivität Do While eine Response- Aktivität hinzu und konfigurieren Sie sie wie folgt:

   • Typ– Erfolg
   • Details– Öffnen Sie den Ausdruckseditor und schreiben Sie Folgendes:

     $context.outputs.Do_While_1.results.flatMap(result => result.content.map(brewery => brewery.name))
     ```This summarizes the response at step 6 and lists only the names of the breweries.
     

8. Kopieren Sie das Ergebnis von der Registerkarte Ausgabe des Bereichs Ausführungsausgabe und konfigurieren Sie es als Ausgabeschema :

   1. Öffnen Sie den Bereich „Data Manager“ .
   2. Wählen Sie auf der Registerkarte Ausgabe die Option Aus Nutzlast generieren.
   3. Fügen Sie das kopierte Ergebnis ein und wählen Sie Schema generieren aus.