globe with meridians Sprache: Deutsch · English

light bulb Architektur Entscheidungen (INTERN)

Interne Design-Entscheidungen zur REST-JSON-Struktur – camelCase, FQNs, attributes-Key und Link-Rendering.

KONZEPT ENTWICKLER STAND: JUL 2026 GILT FUER NUCLOS 4.2026.X

Auf dieser Seite

Hintergrund

Interne Design-Entscheidungen (Entwurf 2015) zur Gestaltung der REST-JSON-Struktur. Für die Nutzung des Service ist die REST-Dokumentation maßgeblich.

Konventionen

  • JSON-Properties in camelCase (z.​B. boMetaId statt bo_meta_id), keine Unterstriche in Keys.
  • FQNs statt UIDs: statt der UID der BO-Meta der Package- und BO-Name (de_test_Auftrag).
  • Attribute klein beginnend (de_test_Auftrag_gesamtsumme) und – wo möglich – nicht voll-qualifiziert (Ausnahmen: VLP, Layout-ML-Regeln).
  • Trennung technischer und fachlicher Attribute: fachlicher Inhalt unter dem Key attributes.
  • Alle Links mit rel-Key, href und methods-Array; Unterformulare unter subforms.

Begründung

Nicht voll-qualifizierte Attribute wurden bevorzugt, weil sie weniger Traffic erzeugen, übersichtlicher sind und Testfälle vereinfachen.

Verwandte Seiten

gear RESTful Service

REST-Service.

Öffnen →

  • Keine Stichwörter