Aufbau der API

Das GraphQL-Schema gliedert seine Felder in drei Ebenen. Das Verständnis dieser Struktur erleichtert das Erkunden des Schemas im GraphiQL Explorer und das Formulieren von Abfragen.

1. Namensraum — ein Feld auf oberster Ebene je Umweltbereich, zum Beispiel water oder radiation.
2. Kategorie — ein Datensatz innerhalb eines Bereichs, zum Beispiel observations, nawa_trend oder nis_survey.
3. Tabelle — die Abfragefelder, die die Daten zurückgeben, zum Beispiel stations, data oder data_live.

Eine Abfrage steigt somit vom Namensraum über die Kategorie zur Tabelle ab:

{
  water {          # Namensraum
    observations { # Kategorie
      stations(limit: 1) {   # Tabelle
        no
        name
      }
    }
  }
}

Dieselbe Struktur findet sich in den Typnamen im GraphiQL Explorer: Der Typ Water_Observations_Stations folgt der Konvention Namensraum_Kategorie_Tabelle.

Zugriff

Der Endpunkt ist schreibgeschützt und ohne Authentifizierung erreichbar. Daten werden mit GraphQL-Abfragen abgerufen; das Schema definiert weder Mutationen noch Subscriptions. Cross-Origin-Anfragen sind zugelassen (CORS-fähig), sodass der Endpunkt direkt aus einem Browser aufgerufen werden kann.

Weiterführende Seiten

• Filter und Operatoren – Einschränken einer Tabelle mit dem where-Argument.
• Paginierung – das Zeilenlimit pro Abfrage und das Iterieren über grössere Ergebnismengen.
• Antwortformat – die Struktur der JSON-Antwort.