OpenAPI-Schemas
Wenn ein OpenAPI 3.1-Dokument (oder eine neuere Version davon) in seinem component/schemas-Objekt OpenAPI-Schemas enthält (siehe Abbildung der Textansicht links unten), können diese Schemas in der grafischen Schema-Ansicht von XMLSpy angezeigt und bearbeitet werden (Abbildung rechts unten). Wechseln Sie dazu einfach von der Text- oder Grid-Ansicht des OpenAPI-Dokuments in die Schema-Ansicht. Daraufhin werden die Schemas im component/schemas-Objekt im Definitionsübersichtsraster (Abbildung rechts unten) angezeigt.
Sie können dies anhand der Datei RaptorXmlXbrl.openapi.yaml aus dem Examples-Projekt von ausprobieren.
Um eines der aufgelisteten Schemas anzuzeigen oder zu bearbeiten, klicken Sie im Definitionsübersichtsraster auf das dazugehörige Symbol.
Die Schemas werden auch in der Eingabehilfe "Übersicht" der Schema-Ansicht angezeigt (Abbildung unten). Sie können hier auf ein Schema doppelklicken, um es in der Design-Ansicht zu bearbeiten.
Die Schemas können auf dieselbe Art wie jedes JSON-Schema bearbeitet werden. Nähere Informationen dazu finden Sie im Abschnitt JSON-Schemas.
Beachten Sie die folgenden Punkte:
•Die im component/schemas-Objekt definierten Schemas werden als benannte Schemas bezeichnet.
•Nur benannte Schemas stehen in der Schema-Ansicht zur Bearbeitung zur Verfügung. Wenn ein Schema an einer andere Stelle im OpenAPI-Dokument definiert ist - d.h. wenn es außerhalb des component/schemas-Objekts definiert ist, steht es nicht zur Bearbeitung in der Schema-Ansicht zur Verfügung.
•Wenn Sie in der Schema-Ansicht eine neue Schema-Definition hinzufügen, wird diese als neues benanntes Schema zum component/schemas-Objekt hinzugefügt.
Validieren von JSON/YAML-Instanzen anhand von JSON-Schemas in OpenAPI-Dateien
Eine JSON- oder YAML-Instanz kann (in der Text- oder Grid-Ansicht) anhand eines JSON-Schemas, das sich innerhalb einer OpenAPI-Datei befindet, validiert werden.
Dabei handelt es sich um eine JSON-Validierung und nicht um eine OpenAPI-Validierung. Das validierte Dokument muss ein JSON- oder YAML-Objekt sein, das nicht mit dem "openapi" oder "swagger"-Schlüssel beginnt. Wenn es mit einem dieser Schlüssel beginnt, so handelt es sich beim Dokument um ein OpenAPI-Dokument, das anhand der OpenAPI-Spezifikation validiert wird; siehe Bearbeiten und Validieren von OpenAPI-Dokumenten.
Um eine JSON- oder YAML-Instanzdatei einem JSON-Schema zuzuweisen, das sich in einem OpenAPI-Dokument befindet, gehen Sie folgendermaßen vor. (Beachten Sie, dass es sich bei der Instanzdatei um eine .json- oder .yaml-Datei handeln muss und dass die Datei als Root-Schlüssel nicht den Schlüssel openapi oder swagger haben darf.)
1.Gehen Sie zum Fenster "Info" der JSON- bzw. YAML-Datei, die keine OpenAPI-Datei ist (Abbildung unten).
2.Klicken Sie auf Validierung anhand von Schema | JSON-Schema auswählen.
3.Wählen Sie die Datei, die das gewünschte JSON-Schema enthält, aus. Dabei kann es sich um eine OpenAPI-Datei oder eine JSON-Schema-Datei handeln. Daraufhin wird das Dialogfeld "Schema auswählen" angezeigt (Abbildung unten), in dem die benannten Schemas der ausgewählten Schema-Datei angezeigt werden. Wenn Sie eine OpenAPI-Datei auswählen, werden ihre benannten Schemas aufgelistet und Sie können eines davon auswählen (Abbildung links unten). Bei Auswahl einer JSON-Schema-Datei (Abbildung rechts unten) können Sie zusätzlich zu den benannten Schemas das Root-Schema auswählen.
4.Klicken Sie auf OK, um die Zuweisung abzuschließen. Die Zuweisung wird im Fenster "Info" (siehe Abbildung in Schritt 1) angezeigt.
Sie können das JSON- oder YAML-Instanzdokument nun anhand der zugewiesenen benannten Schema-Definition oder anhand des zugewiesenen JSON-Schemas mit Hilfe des Befehls XML | XML validieren (F8) validieren.
Generieren einer Beispieldatei
Sie können anhand einer benannten Schema-Definition eine JSON- oder YAML-Beispielstruktur generieren. Die Struktur wird in einer Datei mit dem entsprechenden Dateinamensuffix (.json oder .yaml) generiert.
Gehen Sie dazu folgendermaßen vor:
1.Klicken Sie auf den Befehl DTD/Schema | XML/JSON/YAML-Beispieldatei generieren.
2.Wählen Sie im daraufhin angezeigten Dialogfeld "Schema auswählen" (siehe Abbildung oben) die benannte Schema-Definition, zu der Sie eine Beispieldatei erstellen wollen, aus und klicken Sie auf OK.
3.Wählen Sie im daraufhin angezeigten Dialogfeld "JSON/YAML-Beispieldatei generieren" den gewünschten Dateityp aus (JSON oder YAML), definieren Sie benötigten die Optionen und klicken Sie auf OK.
Der generierten Beispieldatei wurde automatisch als Schema die von Ihnen ausgewählte benannte Schema-Definition zugewiesen und Sie können die Beispieldatei sofort validieren.
Anmerkung: Eine Beispieldatei kann auch erstellt werden, wenn Sie eine neue JSON- oder YAML-Datei erstellen (Menübefehl Datei | Neu) und wenn Sie der Datei zu diesem Zeitpunkt ein JSON-Schema zuweisen.