OpenAPI-Editor und -Tester

OpenAPI Tools

Die OpenAPI-Spezifikation (OAS) ist ein Standard, in dem Web-APIs in einem programmiersprachenunabhängigen Format beschrieben werden. Dadurch steht eine Vorlage dafür zur Verfügung, wie Software-Applikationen über das Internet miteinander kommunizieren. OpenAPI dient zum Schreiben von Anweisungen in JSON oder YAML, in denen API-Details, Endpunkte, Daten und Sicherheitsaspekte beschrieben werden. Mit Hilfe dieser standardisierten Beschreibung können andere Programme mit der API interagieren, ohne deren internen Code zu sehen.

Dabei stützt sich XMLSpy bei der Entwicklung oder Analyse auf intelligente Tools für die Arbeit mit OpenAPI - darunter die Validierung, Bearbeitung und das Testen.

Bearbeitung von OpenAPI-Dokumenten

Unabhängig davon, ob Ihr OpenAPI-Dokument im JSON- oder YAML-Format geschrieben ist, bietet der textbasierte OpenAPI-Editor in XMLSpy intelligente Bearbeitungsfunktionen wie Syntaxmarkierung, Klappleisten, Autokomplettierung und Eingabehilfen.

Bei Wechsel in die Grid-Ansicht bietet XMLSpy zusätzlich eine übersichtliche grafische Darstellung der Dokumentstruktur, die die Navigation im Dokument, die Analyse und die Bearbeitung erleichtert. Neben intelligenten Bearbeitungstools bietet die Grid-Ansicht zelleninterne Befehle, visuelle Bearbeitung mittels Drag-and-Drop und eine Tabellenansicht, in der Nodes auf unterschiedliche Arten angezeigt werden können. Datenabschnitte können erweitert und reduziert angezeigt werden, um die Navigation in großen Dateien und das Auffinden bestimmter Elemente zu erleichtern.

Sowohl in der Text- als auch in der Grid-Ansicht können Dokumente anhand der OpenAPI-Spezifikation validiert werden.

Wenn Sie ein Dokument von Grund auf neu erstellen, bietet XMLSpy vordefinierte Vorlagen zur Erstellung neuer OpenAPI-Dokumente mit Unterstützung für Open API 2.0, 3.0, 3.1 und 3.2.

XMLSpy enthält ein hilfreiches HTTP-Test-Fenster mit Unterstützung für OpenAPI. Darin werden Sie Schritt für Schritt durch die Erstellung und das Senden eines HTTP Request an eine bestehende API geführt. Anschließend kann die Antwort empfangen und überprüft werden. Etwaige Fehler können direkt in diesem Fenster behoben werden.

XMLSpy generiert anhand der für den Test ausgewählten Operation und der Parameter automatisch die Test-Nachricht, die Sie an die API senden können, um die Ergebnisse anschließend anzuzeigen.

Sie können auch direkt von der OpenAPI-Datei aus, an der Sie gerade arbeiten, einen Request generieren. Klicken Sie mit der rechten Maustaste auf eine beliebige Operation und XMLSpy liest den Pfad, die Methode, die Parameter und den Request-Inhalt aus und öffnet im HTTP-Test-Fenster einen fertigen Request.

Dabei wird die gesamte Bandbreite an Requests, die von einer API normalerweise empfangen werden können, einschließlich multipart/form-data Requests für Datei-Uploads und gemischten Inhalt unterstützt. Wenn von einer Operation ein aus mehreren Teilen bestehender Inhalt erwartet wird, erstellt XMLSpy die Teile anhand der OpenAPI-Definition im Vorhinein, sodass Sie nur mehr die Werte und Dateipfade ausfüllen müssen und den Request senden können.

Dank der Möglichkeit Requests zu senden und die Response zu überprüfen, können Sie sicherstellen, dass sich die API während der Entwicklung und Integration wie erwartet verhält. Damit haben Sie ein effektives Werkzeug sowohl zum Testen Ihrer eigenen APIs als auch zur Analyse von Drittanbieter-Schnittstellen in der Hand.