OpenAPI-Editor und -Tester

Bearbeiten, Validieren und Testen von OpenAPI-Dokumenten

Intelligenter OpenAPI-Editor
Textbasierte & grafische Editieroptionen
Validierung auf Basis von OpenAPI
Syntaxmarkierung, Klappleisten, Eingabehilfen
Bearbeitung eines JSON-Schemas auf Basis der OAS

Unterstützung für OpenAPI 1.0, 2.0, 3.0
YAML-Vorlagen für neue OpenAPI Definitionen
Intelligenter YAML- und JSON-Editor
Erstellung und Testen von OpenAPI HTTP Requests

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.

JSON-Schema-Editor

Der JSON-Schema-Editor in XMLSpy unterstützt die Validierung und Bearbeitung von JSON-Schemas auf Basis der OAS. Die visuelle Oberfläche erleichtert das Arbeiten mit komplexen OpenAPI-Schemas in Form einer übersichtlichen grafischen Darstellung der Struktur, wodurch Fehler und Inkonsistenzen schnell und einfach erkannt werden können.

Der JSON Schema Editor bietet Unterstützung für OAS-Erweiterungen wie den Discriminator, XML, Formatierung und externe Dokumente, die in der Eingabehilfe "Details" konfiguriert werden können.

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 OpenAPI 1.0, 2.0 und 3.0.

Erstellung von OpenAPI HTTP Requests

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.

Nach Definition des Pfad zum OpenAPI-Dokument werden die verfügbaren Pfade mit den dazugehörigen Operationen im HTTP-Test-Fenster angezeigt.

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.

Testen von Nachrichten an eine OpenAPI API

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.

Download

Downloaden Sie jetzt eine kostenlose 30-Tage-Testversion von Altova XMLSpy!

Aktualisieren

Bestehende Kunden können hier die aktuellste Version laden.

Kaufen

Erwerben Sie XMLSpy jetzt!