JSON, JSON-Schema

www.altova.com Dieses Kapitel drucken Vorherige Seite Eine Ebene nach oben Nächste Seite

Startseite >  Benutzerhandbuch und Referenz >

JSON, JSON-Schema

JSON (JavaScript Object Notation) ist ein kompaktes Format für die Speicherung und den Austausch von Daten, für das die JavaScript-Syntax verwendet wird. Wie auch das XML-Format ist JSON ein vom Menschen lesbares reines Textformat. Da JSON-Text von jeder Programmiersprache gelesen werden kann, wird es häufig als Format für den Datenaustausch im Internet verwendet.

 

XMLSpy bietet als IDE Unterstützung für die Bearbeitung und Validierung von JSON-Datendokumenten (Instanzdokumente) und die Erstellung von syntaktisch und semantisch korrekten JSON-Schema-Dokumenten.

 

JSON5

JSON5 bildet eine Erweiterung zu JSON, die zusätzlich über einige ECMAScript 5-Erweiterungen verfügt (Nähere Informationen dazu siehe json5.org). JSON5 ist eine streng eingegrenzte Untermenge von JavaScript, enthält zusätzlich zu den vorhandenen JSON-Typen keine neuen Datentypen und lässt sich mit jedem bestehenden JSON-Content verwenden.

 

Alle XMLSpy-Funktionen, die für JSON-Instanzdokumente zur Verfügung stehen, stehen auch für JSON5-Instanzdokumente zur Verfügung. Beachten Sie jedoch die folgenden wichtigen Unterschiede zwischen JSON5 und JSON hinsichtlich der Art, wie XMLSpy die beiden Formate behandelt:

 

JSON5 ist kein offizieller Nachfolger von JSON. Es wird daher eine eigene Dateierweiterung dafür verwendet: json5.
XMLSpy erkennt Dateien mit der Dateierweiterung .json standardmäßig als JSON-Instanzdokumente und Dateien mit der Erweiterung .json5 als JSON5-Instanzdokumente.
JSON5-Instanzdokumente können anhand von JSON-Schemas validiert werden.

 

Mit dem Begriff JSON-Instanzen werden in dieser Dokumentation, falls nicht anders angegeben, sowohl JSON- als auch JSON5-Instanzdokumente bezeichnet. Siehe auch Abschnitt Unterschiede zwischen JSON5 und JSON.

 

JSON und JSON-Schema in XMLSpy

Beide Dokumenttypen - JSON-Instanz und JSON-Schema - sind im JSON-Format verfasst und müssen den JSON-Regeln für Wohlgeformtheit und Gültigkeit entsprechen. Beide Dokumenttypen (Instanz und Schema) haben normalerweise die Dateierweiterung .json. JSON-Instanzen können in der Text- und der Grid-Ansicht bearbeitet werden und ein JSON-Schema-Dokument kann in diesen beiden Ansichten sowie in der JSON-Schema-Ansicht, einem grafischen Schema-Editor, bearbeitet werden.

 

XMLSpy bietet für das Arbeiten mit JSON-Instanz- und JSON-Schema-Dokumenten die folgenden Funktionalitäten:

 

In der Textansicht Syntaxfärbung und Syntaxüberprüfung; Autokomplettierung in JSON-Schemas und in Instanzdokumenten, wenn diese mit einem Schema verknüpft sind, Klappleisten und Strukturmarkierungen. All diese Hilfsmittel vereinfachen die Bearbeitung gültiger JSON-Instanzen und JSON-Schema-Dokumente. In der Textansicht können Instanz- und Schema-Dokumente validiert werden.
eine Strukturansicht in Tabellenform in der Grid-Ansicht, mit der die Dokumentenstruktur besser visualisiert werden kann. Sie können die Bearbeitungen direkt in der Grid-Ansicht vornehmen und während der Bearbeitung je nach Bedarf zwischen Text- und Grid-Ansicht hin- und herwechseln. Auch in der Grid-Ansicht können Instanz- und Schema-Dokumente validiert werden.
Validierung von JSON-Instanzdokumenten in der Textansicht und der Grid-Ansicht. Die Validierung wird anhand eines im Info-Fenster zugewiesenen JSON-Schemas durchgeführt.
In der JSON-Schema-Ansicht werden JSON-Schemas in einem grafischen Layout angezeigt. Dadurch können Sie zur schnellen Erstellung von JSON-Schemas (neben Texteingaben) auch Drag-and-Drop verwenden. Die Eingabehilfen in der Ansicht stellen Bearbeitungshilfen zur Verfügung. Zusätzlich dazu wird das Schema ständig auf Gültigkeit überprüft und Fehler werden markiert.

 

JSON-Instanzen: Öffnen vorhandener Instanzdokumente und Erstellen neuer Instanzdokumente

 

Die Standardansicht (Text- oder Grid-Ansicht), in der JSON/JSON5-Instanzdokumente geöffnet werden sollen, kann im Abschnitt Optionen | Dateiarten eingestellt werden. Vorhandene JSON-Dokumente werden in der von Ihnen ausgewählten Standardansicht geöffnet. Sie können jederzeit zwischen Text- und Grid-Ansicht wechseln.
Um ein neues JSON- oder JSON5-Instanzdokument zu erstellen, klicken Sie auf Datei | Neu und wählen Sie json: JavaScript Object Notation bzw. json5: JSON with ECMAScript 5 extensions aus. Sie werden gefragt, ob Sie optional eine JSON-Schema-Datei für die neue Instanzdatei auswählen möchten. Wenn Sie ein Schema zuweisen, erfolgt dies im Info-Fenster. Das neue Instanzdokument wird, abhängig von den Einstellungen im Abschnitt Optionen | Dateiarten, in der Text- oder Grid-Ansicht geöffnet.

 

 

JSON-Schemas: Öffnen vorhandener Schemas und Erstellen neuer Schemas

 

Ein vorhandenes JSON-Schema-Dokument wird in der JSON-Schema-Ansicht geöffnet. Sie können jederzeit in die Text- oder Grid-Ansicht wechseln.
Um ein neues JSON-Schemadokument zu erstellen, klicken Sie auf Datei | Neu und wählen Sie json: JSON Schema aus. Das neue JSON-Schema-Dokument wird in der JSON-Schema-Ansicht geöffnet, wobei am Anfang des Dokuments das Schlüsselwort $schema zu sehen ist. Sie können jederzeit in die Text- oder Grid-Ansicht wechseln.

 

 

Alle diese Ansichten (Text, Grid und JSON-Schema) sind in den Unterabschnitten dieses Abschnitts beschrieben.

 

In diesem Abschnitt

Dieser Abschnitt ist in die folgenden Kapitel gegliedert:

 

JSON-Daten: Enthält eine Erläuterung der Grundlagen von JSON-Dokumenten.
JSON-Schema: Enthält eine Beschreibung von JSON-Schemas und deren Funktionsweise.
JSON-Dokumente in der Textansicht: Hier wird beschrieben, wie Sie mit JSON-relevanten Funktionen in der Textansicht arbeiten.
JSON-Dokumente in der Grid-Ansicht: Hier wird beschrieben, wie Sie JSON-Dokumente in der Grid-Ansicht bearbeiten.
Validieren von JSON-Daten/-Dokumenten: Hier wird beschrieben, wie Sie einem JSON-Dokument ein JSON-Schema zuweisen und JSON-Dokumente validieren.
JSON-Transformationen mit XSLT/XQuery: Hier wird beschrieben, wie JSON-Dokumente mit Hilfe von XPath/XQuery 3.1 abgefragt werden können.
Generieren eines JSON-Schemas anhand einer JSON-Instanz: Hier werden die Funktionen zum Generieren eines Schemas anhand eines Instanzdokuments beschrieben.
JSON-Schema-Ansicht beschreibt die JSON-Schemabearbeitungsfunktionen der Ansicht und wie Sie diese zur Erstellung Ihrer JSON-Projekte verwenden.

 


© 2019 Altova GmbH