JSON-Schema¶
Die API verwendet für den Datenaustausch bevorzugt JSON. Zur Validierung und Dokumentation der Daten kommt JSON-Schema zum Einsatz. Über den JSON-Editor lassen sich Schemas aus Daten erstellen.
Das Erstellen von JSON-Schemas kann über den Befehl alvine doc:jsonschema:update
erfolgen. Die Daten für das Schema werden
aus der entsprechenden Modell-Klasse genommen. In der Modell-Klasse kann der Titel und die Beschreibung im Kommentar definiert
werden.
Hier ein Beispiel für die Dokumentation
/**
* #erpID Eindeutige ID im Drittsystem (Datum für den Datenaustausch mit Drittsystemen)
* #erpName Name des Drittsystems (Datum für den Datenaustausch mit Drittsystemen)
* #erpNumber Eindeutige Nummer im Drittsystem (Datum für den Datenaustausch mit Drittsystemen)
* #erpLastUpdate Letzte Aktualisierung (Datum für den Datenaustausch mit Drittsystemen)
* #erpCreation Erstellungsdatum (Datum für den Datenaustausch mit Drittsystemen)
*
* @var \array
*/
protected static $erpmapping=[ ...
Konventionen für die Beschreibung von Felder.
- Werden Liste der List-API als Feldwert verwendet, sollte in der Beschreibung ein Hinweis auf die Liste in der Form
(definiert in /api/util/list/<name-der-liste>)"
erfolgen.