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.
XMLSpy bietet die folgende Unterstützung für OpenAPI:
•Validierung von OpenAPI-Dokumenten anhand der OAS. 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.
•Bearbeitungsunterstützung für OpenAPI-Dokumente mit Syntaxfärbung, Klappleisten und Autokomplettierung.
•Erstellung und Senden eines auf einem OpenAPI-Dokument basierenden HTTP Request sowie Empfang und Anzeige der Response
Validierung von OpenAPI-Dokumenten
Ein OpenAPI (OA)-Dokument ist im YAML- oder JSON-Format verfasst und entspricht der (formell als JSON-Schema implementierten) OA-Spezifikation. XMLSpy validiert ein OA-Dokument anhand der folgenden OAS-Versionen: 2.0, 3.0 und 3.1.
Am Anfang eines jeden OA-Dokuments stehen ein obligatorischer Schlüssel und der entsprechende Wert für den Schlüssel (siehe Tabelle unten).
OAS-Version | Schlüssel | Wert |
2.0 | swagger | 2.0 |
3.0 | openapi | 3.0.x |
3,1 | openapi | 3.1.x |
Um das aktive OpenAPI-Dokument zu validieren, wählen Sie den Befehl XML | XML validieren (F8).
Bearbeitungsunterstützung für OpenAPI-Dokumente
XMLSpy bietet die folgenden Be- und Verarbeitungsfunktionalitäten für OpenAPI-Dokumente:
•Erkennung von OpenAPI-Dokumenten (im YAML- oder JSON-Format) anhand ihres Inhalts
•Ermittlung der OpenAPI-Version anhand des obligatorischen openapi-Schlüsselworts
•Validierung des OpenAPI-Dokuments anhand der erkannten OAS-Version
•Anzeige der Dokumentinformationen im Info-Fenster
•Bearbeitung sowohl in der Text- als auch der Grid-Ansicht. Die Bearbeitungsfunktionen dieser beiden Ansichten stehen dort zur Verfügung, wo dies relevant ist - z.B. Syntaxfärbung und Klappleisten
•Unterstützung für Autokomplettierung und Eingabehilfen
•Bereitstellung von YAML-Vorlagen für neue OpenAPI-Dokumente Für jede der unterstützten OAS-Versionen steht eine Vorlagendatei zur Verfügung.
HTTP Requests von OpenAPI-Dokumenten aus
Sie können in XMLSpy anhand eines OpenAPI-Dokuments HTTP Requests erstellen. In der Anleitung unten wird beschrieben, wie Sie anhand einer OpenAPI-Dokument-Datei einen HTTP GET Request erstellen und und den Request an einen Webservice senden.
1.Klicken Sie im Fenster "HTTP" auf HTTP Request anhand von WSDL, WADL oder OpenAPI erstellen.
2.Geben Sie im daraufhin angezeigten Dialogfeld den Pfad zur OpenAPI-Dokument-Datei ein und klicken Sie auf OK. Zum Beispiel: https://petstore3.swagger.io/api/v3/openapi.json.
3.Wählen Sie im nächsten Dialogfeld Operation auswählen den gewünschten Pfad und die gewünschte Operation aus. So ist etwa der Pfad in der Abbildung unten /pet/findByStatus und die dazugehörige GET-Operation ist die ausgewählte Operation.
4.Nachdem Sie auf OK geklickt haben, wird das Dialogfeld HTTP-Request-Parameter angezeigt (Abbildung unten). Die für diesen Parameter im OpenAPI-Dokument definierten Werte werden in der Auswahlliste der Spalte Wert angezeigt. Wählen Sie den gewünschten Wert aus und klicken Sie auf OK.
5.Daraufhin wird der GET Request erstellt und seine URL im oberen Bereich des HTTP-Fensters angezeigt (siehe Abbildung unten).
6.Bei Klick auf Senden wird der Request gesendet und die Response wird rechts im Ergebnisfenster angezeigt (siehe Abbildung unten).
Nähere Informationen dazu finden Sie auch in den folgenden HTTP Kapiteln: Senden des Request und Empfangen der Response.