OpenAPI
In der OpenAPI-Spezifikation (OAS) ist eine Standard-Schnittstelle zu HTTP APIs definiert. Über diese Schnittstelle kann eine Client-Applikation mit einem entfernten Dienst interagieren, ohne dass der Client den Quellcode lesen muss, sodass nur ein Minimum an Implementierungslogik erforderlich ist. Der Ersteller der API beschreibt die API in einem YAML- oder JSON-Dokument in den in der OpenAPI-Spezifikation beschriebenen standardisierten Begriffen. Diese Spezifikation enthält Begriffe aus der Welt der APIs und bettet die Prozeduren von HTTP ein.
Bei einem OpenAPI-Dokument handelt es sich um eine Datei im YAML- oder JSON-Format, in der eine API beschrieben ist, die der OpenAPI-Spezifikation entspricht.
XMLSpy bietet die folgenden Funktionalitäten für OpenAPI. Diese Funktionalitäten werden in den Kapiteln dieses Abschnitts beschrieben:
•Bearbeitungsunterstützung für OpenAPI-Dokumente mit Syntaxfärbung, Klappleisten und Autokomplettierung.
•Validierung von OpenAPI-Dokumenten anhand der OAS und etwaiger interner Schemas im OpenAPI-Dokument.
•Wechseln bei einem OpenAPI-Dokument in die Schema-Ansicht, um die internen Schemas des Dokuments über eine grafischen Oberfläche zu bearbeiten.
•Sie können im Fenster "HTTP" anhand eines OpenAPI-Dokuments einen HTTP Request erstellen, diesen senden und die Response empfangen.