Unterstützung für JSON

JSON (JavaScript Object Notation, siehe auch https://json.org/) ist ein leichtgewichtiges, kompaktes Datenformat zum einfachen Datenaustausch zwischen Anwendungen und Ausgabeformat beispielsweise für die Verwendung des FirstSpirit CaaS.

Korrekt eingerichtet unterstützt FirstSpirit die Vorlagenentwicklung für die JSON-Ausgabe mit einem JSON-Validator. Folgende Schritte sind für die Verwendung des Validators erforderlich:

Präsentationskanal (Servereigenschaften)

Auf jedem FirstSpirit-Server wird automatisch ein System-Präsentationskanal für JSON zur Verfügung gestellt. Der neue Systemkanal wird im ServerManager unter Servereigenschaften / Präsentationskanäle angezeigt (siehe Abbildung).

Der System-Präsentationskanal für JSON verwendet den JSON-Validator für die Nachbearbeitung.

Ein System-Präsentationskanal kann nicht bearbeitet oder gelöscht werden.

Vorlagensatz (Projekt-Eigenschaften)

Um den Präsentationskanal für JSON in den gewünschten Projekten zu aktivieren, muss in den Projekt-Eigenschaften ein entsprechender Vorlagensatz hinzugefügt werden (siehe Abbildung).

Es wird empfohlen, die Option „Template Inspection“ zu deaktivieren.

In der betreffenden Vorlage wird auf dem JSON-Kanal-Register die JSON-Ausgabe dargestellt (wenn sie zuvor mit einer Vorschauseite aus der Struktur verbunden wurde, siehe Register Eigenschaften (→Online Dokumentation FirstSpirit)):

{ "headline": "First Page", "text": "my text" }

Soll die JSON-Ausgabe besser lesbar sein, dann können Einrückungen und Zeilenumbrüche aktiviert werden.

 $CMS_SET(#global.json.prettyPrinting, true)$

Findet der Validator Syntax-Fehler in der JSON-Ausgabe, so werden an den entsprechenden Stellen Hinweise in die Ausgabe geschrieben, z. B.

"hidden":false,"newRow":true,"text":"<h3"> <----- INVALID JSON: expected ',' or '}' - got '>'

Wie bei den meisten Syntax-Überprüfungen kann ein Fehler eine Reihe von vermeintlichen Folgefehlern auslösen, die durch die Korrektur des ersten Fehlers allerdings behoben werden.

"Fehler der Vorschau" aufrufen

Für genauere Hinweise zu einem Fehler kann die Kontextmenü-Funktion Fehler der Vorschau auf der entsprechenden Seite unter Inhalte oder Struktur für den JSON-Kanal aufgerufen werden (siehe dazu Kontextmenü Speziell (→Handbuch FirstSpirit SiteArchitect)).