Struttura dell'API

Lo schema GraphQL organizza i propri campi su tre livelli. La comprensione di questa struttura facilita l'esplorazione dello schema nell'esploratore GraphiQL e la formulazione delle query.

1. Spazio dei nomi — un campo di livello superiore per ciascun ambito ambientale, ad esempio water o radiation.
2. Categoria — un set di dati all'interno di un ambito, ad esempio observations, nawa_trend o nis_survey.
3. Tabella — i campi di query che restituiscono i dati, ad esempio stations, data o data_live.

Una query scende quindi dallo spazio dei nomi attraverso la categoria fino alla tabella:

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

La stessa struttura si ritrova nei nomi dei tipi utilizzati in tutto l'esploratore GraphiQL: il tipo Water_Observations_Stations segue la convenzione Namespace_Category_Table.

Accesso

L'endpoint è di sola lettura e raggiungibile senza autenticazione. I dati vengono recuperati con query GraphQL; lo schema non definisce né mutation né subscription. Le richieste cross-origin sono consentite (compatibili con CORS), pertanto l'endpoint può essere richiamato direttamente da un browser.

Pagine correlate

• Filtri e operatori – restringere una tabella con l'argomento where.
• Paginazione – il limite di righe per query e come iterare su insiemi di risultati più ampi.
• Formato della risposta – la struttura della risposta JSON.