Organisation de l'API

Le schéma GraphQL regroupe ses champs sur trois niveaux. Comprendre cette structure facilite l'exploration du schéma dans l'explorateur GraphiQL ainsi que la rédaction de requêtes.

1. Espace de noms — un champ de premier niveau par domaine environnemental, par exemple water ou radiation.
2. Catégorie — un jeu de données au sein d'un domaine, par exemple observations, nawa_trend ou nis_survey.
3. Table — les champs de requête qui retournent les données, par exemple stations, data ou data_live.

Une requête descend ainsi de l'espace de noms vers la table en passant par la catégorie :

{
  water {          # namespace
    observations { # category
      stations(limit: 1) {   # table
        no
        name
      }
    }
  }
}

La même structure se retrouve dans les noms de types utilisés dans tout l'explorateur GraphiQL : le type Water_Observations_Stations suit la convention Namespace_Category_Table.

Accès

Le point d'accès est en lecture seule et accessible sans authentification. Les données sont récupérées au moyen de requêtes GraphQL ; le schéma ne définit ni mutations ni subscriptions. Les requêtes cross-origin sont autorisées (CORS activé), de sorte que le point d'accès peut être appelé directement depuis un navigateur.

Pages associées

• Filtres et opérateurs – restreindre une table au moyen de l'argument where.
• Pagination – la limite de lignes par requête et la manière d'itérer sur des ensembles de résultats plus volumineux.
• Format de réponse – la structure de la réponse JSON.