Bearbeiten und Validieren von OpenAPI-Dokumenten
Ein OpenAPI (OA)-Dokument ist im YAML- oder JSON-Format verfasst und entspricht der (formell als JSON-Schema implementierten) OA-Spezifikation (OAS).
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.
•Wenn Sie im OpenAPI-Dokument in die Schema-Ansicht wechseln, stehen grafische Bearbeitungsfunktionen für die internen Schemas des Dokuments zur Verfügung.
Validierung von OpenAPI-Dokumenten
XMLSpy validiert ein OA-Dokument anhand der folgenden OAS-Versionen: 2.0, 3.0, 3.1 und 3.2.
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 |
3.2 | openapi | 3.2.x |
Um das aktive OpenAPI-Dokument zu validieren, wählen Sie den Befehl XML | XML validieren (F8). Daraufhin wird das OA-Dokument anhand der entsprechenden OAS und etwaiger zusätzlicher interner Schemas, die das Dokument eventuell enthält, validiert.