-Schema#
Das GraphQL Schema bildet die Datenstruktur der API ab. So werden die abfragbaren Attribute und Operationen dargestellt. Eine Erklärung zu GraphQL kann hier dieser Dokumentation gefunden werden.
Mithilfe des von type können Objekte definiert werden. Dabei unterscheidet man zwischen Query / Mutation und einem Objekt. Eine Query ist eine Abfrage an den Server. Dort wird festgehalten, was eine Abfrage für Filter und Parameter hat. Zudem wird dort auch der Rückgabewert Angegebenen wie bei einer Java Methode. Eine Mutation ist eine Änderung an den Server. Dort wird definiert, was Änderungen an den Server durchführen können. Ein Objekt wird ebenfalls mit diesem Attribut definiert. Es beinhaltet Attribute, welche abgefragt werden können und deren Datentypen. Um vordefinierte Werte zu Verwenden können Enums genutzt werden. Wichtig anzumerken ist, dass es nur sehr wenig Datentypen gibt.
Das Ausrufezeichen ! nach einem Datentyp zeigt an, ob es obligatorisch ist. Dieses Feld wird immer einen Wert zurückgeben und nie leer sein. Ein Beispiel für einen obligatorischen Datentyp ist String!.
Wenn eine Sammlung von Elementen zurückgegeben wird, dann muss es als [] angegeben werden. Ein Beispiel für eine solche Liste ist [String]. Falls es eine Sammlung von Objekten ist, dann kann bei der Abfrage definiert werden, was für Attribute von diesem abgefragt werden.
Schema Version
Sobald eine Änderung am Schema vorgenommen wird, sollte automatisch die aktuellste Version hier angezeigt werden. Auf GitHub kann auch das Schema direkt aufgerufen werden. Wenn beim Laden ein Fehler auftritt, kann dieser in der Konsole inspiziert werden.