Postman API-Aufrufe

Einführung

Dieser Artikel wird tief in die Grundlagen von webbasierenden Diensten eintauchen und Ihnen das Wissen und die praktischen Beispiele vermitteln, die Sie benötigen, um bei der Erstellung von Postman API-Aufrufen versiert zu werden.

Webbasierte Dienste sind seit über zwei Jahrzehnten eine wichtige Komponente moderner Anwendungen und haben sich seit den frühen 2000er Jahren erheblich weiterentwickelt. Diese Dienste verlassen 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 ins Spiel.

Die DataSunrise Web-UI basiert auf API-Aufrufen unter Verwendung von RPC- und JSON-basierten POST-Anfragen. Selbst wenn ein Befehl in der Kommandozeilenschnittstelle (CLI) ausgeführt wird, wird das erforderliche JSON basierend auf den Optionen des Befehls erstellt und dann an das Backend übergeben, um den erforderlichen RPC aufzurufen. Dieser Prozess wird auch in der Webkonsole zum Erstellen und Verwalten von Regeln und anderen Konfigurationen genutzt.

Was ist Postman?

Postman ist ein beliebtes Tool zur API-Entwicklung und -Testung, das den Prozess des Sendens von Anfragen, Analysierens von Antworten und Verwaltens von APIs vereinfacht. Es bietet eine benutzerfreundliche Oberfläche zum Erstellen und Ausführen von API-Aufrufen, wodurch es Entwicklern erleichtert wird, mit webbasierenden Diensten zu arbeiten.

Verstehen von Web-basierten Diensten

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

Schlüsselmerkmale von webbasierenden Diensten

Plattformunabhängigkeit: Webdienste können von jedem Gerät oder Betriebssystem mit Internetverbindung aufgerufen werden.
Interoperabilität: Sie ermöglichen es verschiedenen Systemen, mithilfe standardisierter Protokolle und Datenformate zu kommunizieren.
Skalierbarkeit: Webdienste können mehrere Clients bedienen und mit wachsender Nachfrage wachsen.
Wiederverwendbarkeit: Einmal erstellt, können Webdienste von mehreren Anwendungen genutzt werden, was Code-Wiederverwendung 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 wäre es ein lokaler Prozeduraufruf. RPC ist eine der frühesten Formen der verteilten Datenverarbeitung und hat eine bedeutende Rolle in der Entwicklung webbasierter Dienste gespielt.

Hauptmerkmale von RPC:

Standorttransparenz: Das aufrufende Programm muss nicht den physischen Standort der aufgerufenen Prozedur kennen.
Synchrone Kommunikation: RPC folgt typischerweise einem Anfrage-Antwort-Modell, bei dem der Anrufer auf die Antwort wartet, bevor er fortfährt.
Prozedurorientiert: RPC konzentriert sich auf den Aufruf spezifischer Prozeduren oder Funktionen auf entfernten Systemen.

Verstehen von APIs

Eine Application Programming Interface (API) ist ein Satz von Regeln, Protokollen und Tools, die es verschiedenen Softwareanwendungen ermöglichen, miteinander zu kommunizieren. APIs definieren die Methoden und Datenformate, die Anwendungen verwenden können, um Informationen anzufordern und auszutauschen.

Arten von APIs

SOAP (Simple Object Access Protocol): Ein Protokoll, das XML für den Austausch strukturierter Daten verwendet.
REST (Representational State Transfer): Ein Architekturstil, der Standard-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 verschiedenen Systemen und Anwendungen, nahtlos zusammenzuarbeiten.
Flexibilität: Sie ermöglichen 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 ausführen

Nachdem wir die Grundlagen von web-basierenden Diensten und APIs verstanden haben, lassen Sie uns erkunden, wie man API-Aufrufe mit Postman ausführt. Wir werden zwei Beispiele durchgehen, um verschiedene Arten von API-Aufrufen zu demonstrieren. https://jsonplaceholder.typicode.com ist eine Webseite zum Testen von APIs. Es gibt noch mehr online.

GET-Methode: Eine Anfrage, um spezifische Daten von einem Server abzurufen, ohne Ressourcen zu verändern, typischerweise um Informationen abzurufen und sicher für wiederholte Aufrufe.

POST-Methode: Eine Anfrage, um Daten zu senden, die vom Server verarbeitet und gespeichert werden sollen, oft verwendet, um neue Ressourcen zu erstellen oder Formulardaten zu senden, was den Zustand des Servers verändern kann.

Beispiel 1: Einen GET-Aufruf machen

Beginnen wir mit einem einfachen GET-Aufruf, 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 die folgende URL ein: https://jsonplaceholder.typicode.com/posts/1
Klicken Sie auf die Schaltfläche “Send”.

Sie sollten eine Antwort ähnlich dieser erhalten:

{
"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 mithilfe von Postman abzurufen. Die Antwort enthält ein JSON-Objekt mit Informationen über einen bestimmten Beitrag.

Beispiel 2: Einen POST-Aufruf machen

Nun, lassen Sie uns eine neue Ressource mit einer POST-Anfrage erstellen.

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. Gehen Sie zum Tab “Body”, wählen Sie “raw” und wählen Sie “JSON” aus dem Dropdown-Menü.

5. Geben Sie das folgende JSON in den Körper ein:

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

Klicken Sie auf die Schaltfläche “Send”.

Sie sollten eine Antwort ähnlich dieser erhalten:

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

Dieses Beispiel zeigt, wie man eine neue Ressource mit einer POST-Anfrage erstellt. Die API antwortet mit dem erstellten Objekt, einschließlich einer neuen ID, die vom Server zugewiesen wurde.

Wenn der Server HTTPS verwendet und ein selbstsigniertes Zertifikat hat, müssen Sie möglicherweise die SSL-Zertifikatsüberprüfung in den Postman-Einstellungen ausschalten.

Erweiterte Postman-Funktionen für API-Aufrufe

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

Umgebungsvariablen

Postman ermöglicht es Ihnen, Umgebungsvariablen zu erstellen, um Werte zu speichern und wiederzuverwenden. Dies ist besonders nützlich zum Verwalten verschiedener API-Endpunkte oder Authentifizierungs-Token.

Um Umgebungsvariablen zu verwenden:

Erstellen Sie eine neue Umgebung in Postman.
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.

Vorab-Anfrageskripte

Sie können JavaScript-Code schreiben, der vor dem Senden einer Anfrage ausgeführt wird. Dies ist nützlich zur Generierung dynamischer Daten oder zur Einrichtung der Authentifizierung.

Beispiel-Vorab-Anfrageskript zur Generierung eines Zeitstempels:

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

Tests

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

Beispiel-Testskript im Tests-Abschnitt der neuen GET-Anfrage an https://jsonplaceholder.typicode.com/posts/1?timestamp={{timestamp}}:

// URL analysieren, um den Zeitstempel zu extrahieren
var url = pm.request.url.toString();
var timestamp = url.split('timestamp=')[1];
// Zeitstempel protokollieren
console.log("Timestamp verwendet:", timestamp);
// Fügen Sie den Zeitstempel der Antwort zur Anzeige hinzu
var responseJson = pm.response.json();
responseJson.timestamp = timestamp;
// Stellen Sie die modifizierte Antwort ein, um sie in Postman zu visualisieren
pm.visualizer.set(JSON.stringify(responseJson, null, 2));
// Test, um sicherzustellen, dass der Zeitstempel gesendet wurde
pm.test("Anforderung mit Zeitstempel gesendet", function () {
    pm.expect(timestamp).to.not.be.undefined;
});

Überprüfen Sie den Tab “Testergebnisse”, um zu sehen, ob der Test bestanden wurde. Überprüfen Sie auch den Tab “Konsole”, um den protokollierten Zeitstempel zu sehen. Der Antwortkörper wird jetzt den Zeitstempelwert enthalten.

Best Practices für API-Aufrufe mit Postman

Organisieren Sie Ihre Anfragen: Verwenden Sie Sammlungen und Ordner, um verwandte Anfragen zu gruppieren.
Verwenden Sie Versionskontrolle: Postman ermöglicht es Ihnen, Sammlungen zu exportieren. Speichern Sie diese in Versionskontrollsystemen wie Git.
Dokumentieren Sie Ihre APIs: Verwenden Sie die Dokumentationsfunktion von Postman, um klare, interaktive API-Dokumentationen zu erstellen.
Automatisieren Sie Tests: Nutzen Sie den Collection Runner und Newman CLI von Postman, um Ihre API-Tests zu automatisieren.
Handhaben Sie Authentifizierung richtig: Verwenden Sie Umgebungsvariablen, um sensible Informationen wie API-Schlüssel oder Token zu speichern.
Überwachen Sie die API-Leistung: Richten Sie Monitore in Postman ein, um die Leistung und Betriebszeit Ihrer API zu verfolgen.

Fazit

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

Wir haben die Grundlagen des Machens von API-Aufrufen behandelt, erweiterte Postman-Funktionen erkundet und Best Practices diskutiert. Mit diesem Wissen sind Sie bestens gerüstet, um komplexe API-Interaktionen zu bewältigen und robuste, vernetzte Anwendungen zu erstellen.

Denken Sie daran, dass der Schlüssel zur Beherrschung von Postman API-Aufrufen die Praxis ist. Experimentieren Sie mit verschiedenen Anfragen, 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 in Betracht ziehen, fortgeschrittene Themen wie API-Sicherheit, Leistungsoptimierung und Integrationstests zu erkunden. Die Welt der web-basierten Dienste ist umfangreich und sich ständig weiterentwickelnd und bietet endlose Möglichkeiten zum Lernen und Wachsen.