Ankündigung des Vonage Ruby SDK Version 7.3.0

Das Vonage Ruby SDK hat kürzlich eine neue Version, v7.3.0, veröffentlicht. Diese neue Version führt eine Auto-Pagination-Funktion für API-Listenmethoden ein, die das Sammeln von Daten aus den Vonage APIs vereinfacht.

Lassen Sie uns untersuchen, was dahinter steckt und wie es funktioniert.

Warum automatische Umbrüche einführen?

Warum sollten Sie bei der Arbeit mit Vonage-APIs über Paginierung nachdenken, und wie kann die automatische Paginierung Ihr Erlebnis verbessern?

Wir können dies am besten verstehen, wenn wir uns ein Beispiel aus der Praxis ansehen.

Mit der Vonage Voice API können Sie Details zu all Ihren Anrufen abzurufen. Wenn wir diese GET Anfrage an die API ohne Parameter stellen, werden standardmäßig nur die ersten zehn Anrufe zurückgegeben.

Was passiert, wenn Sie mehr als zehn Aufrufe haben? Sie müssen für jede weitere Seite mit Datensätzen weitere API-Anfragen stellen. Das bedeutet, dass Sie die aktuelle Seite, die Anzahl der verbleibenden Seiten und die Anzahl der Datensätze pro Seite im Auge behalten müssen. Das ist vielleicht eine größere kognitive Belastung als erwartet, wenn Sie nur eine Liste Ihrer Aufrufe haben wollen.

Glücklicherweise wird diese Arbeit jetzt mit Version 7.3.0 des Ruby SDK von Ihrer Verantwortung abstrahiert.

Wie das Vonage SDK-Team in einem Blog-Beitragbeschrieben hat, sind wir der festen Überzeugung, dass unsere SDKs in erster Linie dazu dienen sollten, Ihnen als Entwickler das Leben zu erleichtern und Ihnen zu ermöglichen, Ihre Arbeit so problemlos wie möglich zu erledigen. Die automatische Paginierung im Ruby SDK ist ein weiterer Schritt in Richtung dieses großen Ziels.

Wie funktioniert es?

Bei der Einführung neuer Funktionen in das Ruby SDK ist es wichtig, die Arbeitsabläufe derjenigen, die das SDK regelmäßig für ihre Arbeit nutzen, so wenig wie möglich zu beeinträchtigen. Daher müssen Sie bei der automatischen Weiterleitung nur sehr wenig tun, um die Verbesserungen zu nutzen.

Die Abfrage aller Anrufdatensätze kann jetzt mit demselben Methodenaufruf erfolgen, den Sie bereits im SDK verwendet haben:

client = Vonage::Client.new
client.applications.list

Jetzt geht das SDK jedoch automatisch durch alle Seiten mit Datensätzen und fügt sie der Sammlung der an Sie zurückgegebenen Aufrufe hinzu. Zuvor gab dieser Methodenaufruf nur die Standardanzahl von Datensätzen für die API zurück (in diesem Fall 10), und Sie mussten weitere API-Anfragen stellen, um die restlichen Datensätze zu sammeln.

Es gibt Situationen, in denen Sie nicht alle Ihre Datensätze zurückgeben möchten. Es ist möglich, die automatische Weiterleitung zu deaktivieren, indem Sie ein zusätzliches Argument im Methodenaufruf von auto_advance: false. Wenn Sie zum Beispiel nur die ersten fünf Aufrufe zurückgeben möchten, würde Ihre Methode wie folgt aussehen:

client = Vonage::Client.new
client.applications.list(page_size: 5, auto_advance: false)

Sie müssen nur dann das Argument auto_advance Argument in Ihrem Code hinzufügen, wenn Sie das Standardverhalten ausdrücklich nicht wünschen. Bei den meisten APIs ist das Standardverhalten die automatische Weiterleitung.

Was kommt als Nächstes?

Wir haben weitere spannende Pläne für das Ruby-SDK in Arbeit! Wir bauen die Funktionen des SDKs weiter aus, um es noch besser auf unser Ziel auszurichten, eine Ressource zu sein, die nicht nur HTTP-Anfragen für Sie stellt, sondern vor allem Ihre Aufgaben einfacher und effizienter macht.

Wir freuen uns immer über die Beteiligung der Gemeinschaft. Sie können sich uns gerne auf GitHub und dem Vonage Community Slack.