Skip to content

Latest commit

 

History

History
66 lines (54 loc) · 4.1 KB

json-ld.md

File metadata and controls

66 lines (54 loc) · 4.1 KB
Raw

JSON-LD

offizielle Webseite: json-ld.org

Kurzbeschreibung

JSON steht für "JavaScript Object Notation" und der Suffix LD für "Linked Data" Mit ihm soll es Webnutzern weltweit ermöglicht werden, standardisierte und maschienenlesbare Datenformate zu nutzen. Während im context-Teil des JSON ein einzelner Link sich befindet, kann in der dort aufgerufenen Beschreibung eine vielzahl weiterführender Links und somit weiterer verlinkter Daten stehen. Linked Data Abschnitt

Funktionsweise

  1. JSON-Struktur: Verwendung der JSON-Syntax für leicht lesbare Daten.
  2. Verknüpfte Daten: Nutzung von URIs, um Beziehungen zwischen Datenpunkten herzustellen.
  3. Kontext: Definition von Bedeutungen durch den Kontext, der angibt, wie Schlüssel interpretiert werden sollen.
  4. Typisierung: Möglichkeit, Datenpunkte zu typisieren, um die Art der Daten zu kennzeichnen.
  5. HTML-Einbettung: Integration in HTML-Dokumente für maschinenlesbare Informationen, besonders relevant für SEO.

Umsetzung

Webseite-Ansicht

Um die API-Rückgaben verständlich und beschreibend zu gestalten, wurde ein weiterer Controller hinzugefügt. Dieser MVCModel-View-Controller-Controller gibt über die Route "views/json-ld" eine Webseite zurück, deren Inhalt die Beschreibung des JSON darstellt, welche die Abfragerouten zurückgeben werden.

  • HTML aktuell noch leer, weil Endpunkte nicht genau definiert.
  • Name der HTML vllt ebenfalls noch anzupassen.
  • Auch die Route ist noch nicht final, falls weitere Definitionen eingebunden werden sollten später, sind diese anzupassen damit der Grundweg "views/json-ld" als Hauptteil identisch bleibt und dort dann eine Subroute definiert wird, wie z.B. "/cve" für die CVE-Datendefinition - "/packages" für die Beschreibung, welche Pakte problematisch sind mit dem Indikator dazu etc.

JSON-Context

Im Allgemeinen bezieht sich der "@context"-Schlüssel in JSON-LD auf die Definition der Bedeutung oder Semantik der verwendeten Begriffe (Schlüssel) in einem JSON-LD-Dokument. Er spielt eine zentrale Rolle bei der Interpretation der Daten, indem er angibt, wie die verschiedenen Schlüssel und Werte zu verstehen sind.

Der @context kann in unterschiedlichen Formen angegeben werden:

  1. IRI (Internationalized Resource Identifier): Eine Zeichenfolge, die auf eine externe Ressource verweist, die die Bedeutung der verwendeten Begriffe definiert. Zum Beispiel "@context": "http://schema.org/", wobei Schema.org ein gemeinsames Vokabular für strukturierte Daten ist.
  2. Objekt: Ein eingebettetes JSON-Objekt, das die Bedeutung der Schlüssel im aktuellen Dokument angibt.

Der "@context" ermöglicht also eine klare Definition der Semantik und erleichtert die interoperable Verwendung von strukturierten Daten im Web, da er sicherstellt, dass verschiedene Systeme und Anwendungen ein gemeinsames Verständnis der Daten haben.

Aufgetretene Probleme

  1. Die Beschreibung des HTML-Dokuments, welches angezeigt werden soll, muss als String zurückgegeben werden von dem Endpunkt. Für eine volle Beschreibung ist dies jedoch ein sehr langer String, welches die Controller-Datei stark aufbläht.

Lösung der Probleme

Zu den Punkten oben hier die Lösungen mit den selben Nummern:

  1. Der Inhalt wurde in eine eigene html-Datei ausgelagert und dann über das Dateisystem geladen - System.IO.File. Somit wird die Controller-Beschreibung schlanker und eine bessere Wartbarkeit gewährleistet.

Sonstiges

Schema.org ist eine Kooperation von Suchmaschinen, die ein standardisiertes Vokabular für strukturierte Daten im Web bereitstellt. Es ermöglicht Website-Betreibern, Informationen auf ihren Seiten eindeutig zu markieren, was Suchmaschinen bei der präzisen Interpretation und Anzeige unterstützt. Durch die Verwendung von Schema.org können Websites ihre Sichtbarkeit in den Suchergebnissen verbessern.