Postman API-Aufrufe

Einführung

Dieser Artikel taucht tief in die Grundlagen webbasierter Dienste ein und stattet Sie mit dem Wissen und praktischen Beispielen aus, die benötigt werden, um sich im Umgang mit Postman API-Aufrufen auszukennen.

Webbasierte Dienste sind seit über zwei Jahrzehnten ein entscheidender Bestandteil moderner Anwendungen und haben sich seit den frühen 2000er Jahren erheblich weiterentwickelt. Diese Dienste stützen sich stark auf APIs (Application Programming Interfaces), um zu kommunizieren und Daten auszutauschen. Als Entwickler und Tester benötigen wir robuste Werkzeuge, um effektiv mit diesen APIs zu interagieren. Hier kommt Postman – ein beliebtes Tool zur API-Testung und -Entwicklung ins Spiel.

Die DataSunrise Web-Oberfläche basiert auf API-Aufrufen unter Verwendung von RPC und JSON-basierten POST-Anfragen. Selbst wenn ein Befehl in der Command Line Interface (CLI) ausgeführt wird, wird das erforderliche JSON basierend auf den Optionen des Befehls erstellt, das dann an das Backend weitergegeben wird, um den benötigten RPC aufzurufen. Dieser Prozess wird auch in der Web-Konsole genutzt, um Regeln und andere Konfigurationen zu erstellen und zu verwalten.

Was ist Postman?

Postman ist ein populäres Tool zur API-Entwicklung und -Testung, das den Prozess des Sendens von Anfragen, Analysierens von Antworten und Verwalten von APIs vereinfacht. Es bietet eine benutzerfreundliche Oberfläche zur Erstellung und Ausführung von API-Aufrufen, was es Entwicklern erleichtert, mit webbasierten Diensten zu arbeiten.

Grundlagen webbasierter Dienste

Webbasierte Dienste sind Anwendungen oder Komponenten, die über Netzwerke mittels standardisierter Webprotokolle kommunizieren. Diese Dienste ermöglichen es verschiedenen Softwaresystemen, nahtlos miteinander zu interagieren und Daten auszutauschen, unabhängig von deren zugrunde liegenden Technologien oder Plattformen.

Hauptmerkmale webbasierter Dienste

Plattformunabhängigkeit: Webdienste können von jedem Gerät oder Betriebssystem mit Internetverbindung aus genutzt werden.
Interoperabilität: Sie ermöglichen es unterschiedlichen Systemen, mittels standardisierter Protokolle und Datenformate zu kommunizieren.
Skalierbarkeit: Web-Dienste können mehrere Clients bedienen und bei steigendem Bedarf wachsen.
Wiederverwendbarkeit: Einmal erstellt, können Webdienste von mehreren Anwendungen genutzt werden, was die Wiederverwendung von Code und Effizienz fördert.

Was ist RPC?

Remote Procedure Call (RPC) ist ein Protokoll (JSON-RPC), das es einem Programm ermöglicht, eine Prozedur oder Funktion auf einem anderen Computer auszuführen, als handele es sich um einen lokalen Funktionsaufruf. RPC ist eine der frühesten Formen des verteilten Rechnens und hat eine bedeutende Rolle in der Entwicklung webbasierter Dienste gespielt.

Schlüsseleigenschaften von RPC:

Ortsunabhängigkeit: Das aufrufende Programm muss den physischen Ort der aufgerufenen Prozedur nicht kennen.
Synchroner Datenaustausch: RPC folgt in der Regel einem Anfrage-Antwort-Modell, wobei der Aufrufer auf die Antwort wartet, bevor er fortfährt.
Prozedurorientierung: RPC konzentriert sich darauf, bestimmte Prozeduren oder Funktionen auf entfernten Systemen aufzurufen.

Verständnis von APIs

Eine Application Programming Interface (API) ist ein Satz von Regeln, Protokollen und Werkzeugen, der es verschiedenen Softwareanwendungen ermöglicht, miteinander zu kommunizieren. APIs definieren die Methoden und Datenformate, die Anwendungen zur Anforderung und zum Austausch von Informationen nutzen können.

API-Typen

SOAP (Simple Object Access Protocol): Ein Protokoll, das XML zum Austausch strukturierter Daten verwendet.
REST (Representational State Transfer): Ein Architekturstil, der standardmäßige HTTP-Methoden zur Kommunikation verwendet.
GraphQL: Eine Abfragesprache für APIs, die es Clients ermöglicht, spezifische Daten anzufordern, die sie benötigen.

Warum APIs wichtig sind

Integration: APIs ermöglichen es unterschiedlichen Systemen und Anwendungen, nahtlos zusammenzuarbeiten.
Flexibilität: Sie erlauben es Entwicklern, auf spezifische Funktionen anderer Anwendungen zuzugreifen, ohne deren gesamten Code verstehen zu müssen.
Effizienz: APIs können die Entwicklungszeit verkürzen, indem sie vorgefertigte Funktionen bereitstellen.
Skalierbarkeit: Gut gestaltete APIs können erhöhte Lasten und wachsende Benutzerzahlen bewältigen.

API-Aufrufe mit Postman durchführen

Nachdem wir die Grundlagen webbasierter Dienste und APIs verstanden haben, wollen wir nun erkunden, wie man API-Aufrufe mit Postman durchführt. Wir werden zwei Beispiele durchgehen, um verschiedene Arten von API-Aufrufen zu demonstrieren. JSONPlaceholder ist eine Website zum Testen von APIs. Es gibt noch weitere Online-Test-APIs.

GET-Methode: Eine Anfrage, um bestimmte Daten von einem Server abzurufen, ohne dabei Ressourcen zu verändern. Sie wird typischerweise zum Abrufen von Informationen genutzt und ist für wiederholte Aufrufe sicher.

POST-Methode: Eine Anfrage, um Daten zur Verarbeitung und Speicherung an den Server zu senden. Sie wird oft verwendet, um neue Ressourcen zu erstellen oder Formulardaten zu übermitteln, was zur Änderung des Serverzustandes führen kann.

Beispiel 1: Einen GET-Request durchführen

Beginnen wir mit einem einfachen GET-Request, um Daten von einer öffentlichen API abzurufen.

Öffnen Sie Postman und erstellen Sie eine neue Anfrage.
Setzen Sie die HTTP-Methode auf GET.
Geben Sie folgende URL ein: https://jsonplaceholder.typicode.com/posts/1
Klicken Sie auf die Schaltfläche “Senden”.

Sie sollten eine Antwort erhalten, die ungefähr so aussieht:

{
  "userId": 1,
  "id": 1,
  "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
  "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto"
}

Dieses Beispiel zeigt, wie einfach es ist, Daten von einer API mit Postman abzurufen. Die Antwort enthält ein JSON-Objekt mit Informationen zu einem bestimmten Beitrag.

Beispiel 2: Einen POST-Request durchführen

Erstellen wir nun eine neue Ressource mittels eines POST-Requests.

1. Erstellen Sie eine neue Anfrage in Postman.

2. Setzen Sie die HTTP-Methode auf POST.

3. Geben Sie die URL ein: https://jsonplaceholder.typicode.com/posts

4. Wechseln Sie zur Registerkarte “Body”, wählen Sie “raw” und dann “JSON” aus dem Dropdown-Menü.

5. Geben Sie im Body folgenden JSON-Inhalt ein:

{
  "title": "My New Post",
  "body": "This is the content of my new post.",
  "userId": 1
}

Klicken Sie auf die Schaltfläche “Senden”.

Sie sollten eine Antwort erhalten, die in etwa so aussieht:

{
  "title": "My New Post",
  "body": "This is the content of my new post.",
  "userId": 1,
  "id": 101
}

Dieses Beispiel zeigt, wie man mittels eines POST-Requests eine neue Ressource erstellt. Die API antwortet mit dem erstellten Objekt, einschließlich einer neuen vom Server zugewiesenen ID.

Falls der Server HTTPS verwendet und ein selbstsigniertes Zertifikat vorliegt, müssen Sie möglicherweise die SSL-Zertifikatsprüfung in den Postman-Einstellungen deaktivieren.

Erweiterte Postman-Funktionen für API-Aufrufe

Postman bietet mehrere erweiterte Funktionen, die Ihren API-Test- und Entwicklungsworkflow verbessern können:

Umgebungsvariablen

Postman ermöglicht es, Umgebungsvariablen zu erstellen, um Werte über mehrere Anfragen hinweg zu speichern und wiederzuverwenden. Dies ist besonders nützlich, um verschiedene API-Endpunkte oder Authentifizierungstoken zu verwalten.

So verwenden Sie Umgebungsvariablen:

Erstellen Sie in Postman eine neue Umgebung.
Fügen Sie Variablen wie base_url oder api_key hinzu.
Verwenden Sie diese Variablen in Ihren Anfragen mit doppelten geschweiften Klammern, z. B. {{base_url}}/api/endpoint.

Pre-request Scripts

Sie können JavaScript-Code schreiben, der vor dem Senden einer Anfrage ausgeführt wird. Dies ist nützlich, um dynamische Daten zu generieren oder die Authentifizierung vorzubereiten.

Beispiel eines Pre-request-Skripts zur Generierung eines Zeitstempels:

pm.environment.set(“timestamp”, new Date().getTime());

Tests

Postman ermöglicht es, Tests für Ihre API-Aufrufe mittels JavaScript zu schreiben. Diese Tests können die Antwortdaten validieren, Statuscodes überprüfen oder andere Überprüfungen durchführen.

Beispiel eines Test-Skripts im Tests-Bereich für eine neue GET-Anfrage an https://jsonplaceholder.typicode.com/posts/1?timestamp={{timestamp}}:

// URL parsen, um den Zeitstempel zu extrahieren
var url = pm.request.url.toString();
var timestamp = url.split('timestamp=')[1];
// Protokolliere den Zeitstempel
console.log("Verwendeter Zeitstempel:", timestamp);
// Füge den Zeitstempel der Antwort zur besseren Sichtbarkeit hinzu
var responseJson = pm.response.json();
responseJson.timestamp = timestamp;
// Setze die modifizierte Antwort zur Visualisierung in Postman
pm.visualizer.set(JSON.stringify(responseJson, null, 2));
// Test, um sicherzustellen, dass der Zeitstempel gesendet wurde
pm.test("Anfrage mit Zeitstempel gesendet", function () {
    pm.expect(timestamp).to.not.be.undefined;
});

Überprüfen Sie den Reiter “Test Results”, um zu sehen, ob der Test erfolgreich war. Sehen Sie auch im Reiter “Console” nach, um den protokollierten Zeitstempel zu überprüfen. Der Antwortkörper enthält nun den Zeitstempelwert.

Best Practices für API-Aufrufe mit Postman

Organisieren Sie Ihre Anfragen: Nutzen Sie Sammlungen (Collections) und Ordner, um zusammengehörige Anfragen zu gruppieren.
Verwenden Sie Versionskontrolle: Postman ermöglicht den Export von Sammlungen. Speichern Sie diese in Versionskontrollsystemen wie Git.
Dokumentieren Sie Ihre APIs: Nutzen Sie die Dokumentationsfunktion von Postman, um klare, interaktive API-Dokumentationen zu erstellen.
Automatisieren Sie Tests: Nutzen Sie den Collection Runner von Postman und die Newman CLI, um Ihre API-Tests zu automatisieren.
Handhaben Sie die Authentifizierung ordnungsgemäß: Verwenden Sie Umgebungsvariablen, um sensible Informationen wie API-Schlüssel oder Tokens zu speichern.
Überwachen Sie die API-Leistung: Richten Sie in Postman Monitore ein, um die API-Leistung und Verfügbarkeit zu verfolgen.

Fazit

Die Beherrschung von Postman API-Aufrufen ist eine wesentliche Fähigkeit für moderne Entwickler und Tester. Durch das Verständnis webbasierter Dienste, von APIs und RPC können Sie die leistungsstarken Funktionen von Postman nutzen, um Ihre Entwicklungs- und Testprozesse für APIs zu optimieren.

Wir haben die Grundlagen der Durchführung von API-Aufrufen behandelt, erweiterte Postman-Funktionen erkundet und Best Practices besprochen. Mit diesem Wissen sind Sie bestens gerüstet, komplexe API-Interaktionen anzugehen und robuste, vernetzte Anwendungen zu erstellen.

Denken Sie daran: Der Schlüssel zur Beherrschung von Postman API-Aufrufen liegt in der Praxis. Experimentieren Sie mit verschiedenen Anfragetypen, erkunden Sie öffentliche APIs und fordern Sie sich selbst heraus, umfassende Testsuiten für Ihre eigenen APIs zu erstellen.

Wenn Sie Ihre Reise in der API-Entwicklung und -Testung fortsetzen, sollten Sie auch fortgeschrittene Themen wie API-Sicherheit, Leistungsoptimierung und Integrationstests in Betracht ziehen. Die Welt der webbasierenden Dienste ist riesig und ständig im Wandel – sie bietet unendlich viele Möglichkeiten zum Lernen und Wachsen.