REST (Representational State Transfer) ist zum Standard für das Erstellen von Web-APIs geworden, die von mehreren Clients genutzt werden können. Beim Entwickeln einer REST-API ist es wichtig, sie zu testen, um sicherzustellen, dass sie Anfragen und Antworten ordnungsgemäß verarbeitet. Nun zeigen wir Ihnen, wie Sie cURL verwenden, um WebSocket-APIs zu testen und REST-APIs mit cURL-Befehlen zu testen. Schauen wir mal.
Methode 1. CURL für WebSocket-Tests mit Apidog
cURL ist ein Befehlszeilen-Tool zum Senden von HTTP-Anfragen, während Apidog eine grafische Oberfläche bietet, um das Testen von WebSockets zu vereinfachen. Apidog macht es überflüssig, cURL-Befehle manuell zu konfigurieren, wodurch es einfacher wird, Nachrichten an WebSocket-Endpunkte zu erstellen, zu speichern und zu senden. Seine intuitive Benutzeroberfläche ermöglicht es sowohl Anfängern als auch erfahrenen Entwicklern, ihre WebSockets effizienter zu debuggen.
Sie können eine WebSocket-Anfrage erstellen, Nachrichten und Parameter festlegen, die Anfrage speichern, sich mit dem WebSocket-Dienst verbinden und WebSocket-Anfragen senden. Dieser Ansatz eliminiert die Komplexität manueller cURL-Befehle und macht WebSocket-Tests zugänglicher.
Schritt 1. Sie können eine WebSocket-API erstellen, indem Sie auf die Schaltfläche „+“ neben der Suchleiste klicken.
Die Option „Neue WebSocket-API (Beta)“ befindet sich im Dropdown-Menü. Klicken Sie darauf, und Sie können die URL Ihrer WebSocket-API eingeben, um eine Verbindung herzustellen und Nachrichten zu senden/empfangen.
Schritt 2. Im Nachrichtenbereich können Sie nun die Informationen hinzufügen, die Sie an den Server senden müssen, und der Server erfasst diese Informationen an seinem Ende.
Schritt 3. Sie können die Parameter entsprechend Ihren Anforderungen festlegen. Sie können Ihre Datentypen auf Strings, Ints, Arrays usw. einstellen.
Schritt 4. Nachdem Ihre Anfrage ausgeführt wurde, können Sie sie für die zukünftige Verwendung speichern. Dies ermöglicht einen einfachen Zugriff auf die Anfrage.
Schritt 5. Sie können sich jetzt verbinden und WebSocket-Anfragen senden, um eine WebSocket-Verbindung herzustellen. Dies können Sie tun, indem Sie auf die Schaltfläche „Verbinden“ neben der Suchleiste klicken. Nach erfolgreichem Abschluss der Verbindung wird eine Erfolgsmeldung angezeigt.
Schritt 5. Sie können jetzt mit dem Server über den von Ihnen gerade erstellten WebSocket kommunizieren. Sie können Ihre Nachrichten und Parameter an den Server senden, indem Sie auf die Schaltfläche „Senden“ klicken.
Sie können auch mit dem Client kommunizieren, nachdem die Verbindung erfolgreich hergestellt wurde.
API-Automatisierung mit cURL in Apidog
Die API-Automatisierung mit cURL in Apidog beinhaltet die Nutzung der Fähigkeiten von cURL-Befehlen innerhalb der Apidog-Plattform. Dies hilft bei der Straffung und Automatisierung von API-Tests und -Interaktionen. Die Schritt-für-Schritt-Anleitung zur Erreichung der API-Automatisierung finden Sie unten. Sie müssen jetzt cURL-Befehle in Apidog importieren.
Greifen Sie auf das Apidog-Importfenster zu und fügen Sie cURL-Befehle in das bereitgestellte Textfeld ein. Dies ermöglicht die nahtlose Integration von cURL-Befehlen in die Apidog-Plattform. Sie können dafür jedes Paketaufzeichnungstool verwenden.
Als Nächstes müssen Sie Ihre Automatisierungseinstellungen konfigurieren. Sie müssen zur Einstellungsseite navigieren. Dort können Sie die Häufigkeit automatisierter API-Aufrufe festlegen und die Fehlerbehandlung durchführen.
Verwenden Sie die Testtools von Apidog, um automatisierte API-Workflows aktiv zu testen und zu verfeinern. Sie können Protokolle überprüfen, Leistungsmetriken analysieren und Anpassungen vornehmen, um die automatisierten API-Aufrufe auf Zuverlässigkeit und Effizienz zu optimieren.
Methode 2. Testen von REST-APIs mit cURL-Befehlen
Eine weitere einfache Möglichkeit, eine REST-API zu testen, ist über cURL-Befehle in Ihrem Terminal. cURL ist ein Befehlszeilen-Tool, mit dem HTTP-Anfragen zum Testen von APIs gestellt werden können. In diesem Abschnitt werden wir sehen, wie man cURL verwendet, um einige gängige API-Szenarien zu testen.
Testen einer GET-Anfrage
Um das Abrufen einer Ressource von einer API zu testen, können wir eine GET-Anfrage mit curl stellen. Zum Beispiel:
cURL https://myapi.com/users/1
Dadurch wird eine GET-Anfrage an den /users/1-Endpunkt gesendet und die Rohantwort angezeigt.
Wir können auch das Flag -i übergeben, um Antwortheader einzuschließen:
cURL -i https://myapi.com/users/1
Dies hilft zu validieren, dass die API den korrekten Statuscode wie 200 OK zurückgibt.
Testen einer POST-Anfrage
Um das Erstellen einer Ressource zu testen, müssen wir eine POST-Anfrage stellen. Zum Beispiel, um einen neuen Benutzer zu erstellen:
cURL -X POST -H "Content-Type: application/json" -d '{"name":"John", "email":"john@example.com"}' https://myapi.com/users
Hier verwenden wir -X POST, um eine POST-Anfrage zu stellen, -H, um den Content-Type-Header festzulegen, und -d, um eine JSON-Nutzlast zu übergeben.
Die API sollte bei Erfolg einen 201 Created-Status zurückgeben.
Testen von PUT und PATCH
Um das Aktualisieren einer Ressource zu testen, können Sie PUT- oder PATCH-Anfragen genau wie POST stellen.
Um beispielsweise die E-Mail-Adresse eines Benutzers mit einer PUT-Anfrage zu aktualisieren:
cURL -X PUT -H "Content-Type: application/json" -d '{"email":"john@newdomain.com"}' https://myapi.com/users/1
Und PATCH, um nur die E-Mail-Adresse eines Benutzers teilweise zu aktualisieren:
cURL -X PATCH -H "Content-Type: application/json" -d '{"email":"john@newdomain.com"}' https://myapi.com/users/1
Testen von DELETE
Um das Löschen einer Ressource zu testen, stellen Sie eine DELETE-Anfrage:
cURL -X DELETE https://myapi.com/users/1
Die API sollte bei Erfolg eine 204 No Content-Antwort zurückgeben.
Fazit
cURL bietet eine schnelle und einfache Möglichkeit, REST-API-Endpunkte zu testen. Sie können problemlos verschiedene Arten von Anfragen stellen und Antworten untersuchen. Wenn Sie eine neue API entwickeln, versuchen Sie, cURL zu verwenden, um zu validieren, dass sie CRUD-Operationen wie erwartet verarbeitet, bevor Sie sie in das Frontend integrieren.
