Maken van een GraphQL query

Bevraag de data met een krachtig query-paradigme

In dit onderdeel van de tutorial maken we je wegwijs in het GraphQL queryparadigma en laten we je kennis maken met het GraphQL endpoint, waarmee jij snel je eerste query kunt testen.

Doel van deze module

Na deze module, stap 2 van de tutorial, kun je aan je collega’s uitleggen:

• Hoe je een simpele GraphQL query kunt opbouwen
• Hoe je het GraphQL endpoint gebruikt om snel queries te kunnen maken

Voordat je begint

Gedurende deze module zullen we verschillende queries uitoefenen met GraphQL op de BAG. Om deze queries te versturen gebruiken we het GraphQL endpoint op deze URL.

GraphQL

GraphQL is een relatief nieuwe API-standaard die een efficiënter, krachtiger en flexibeler alternatief biedt voor de traditionele REST API. In deze tutorial leren we je de basis waarmee je je eerste selectie en combinatie vraag kan stellen aan de Kadaster datasets.

Opstellen van een eerste GraphQL query

Laten we met een simpele query beginnen. We gaan voor de eerste 10 BAG verblijfsobjecten het oppervlakte en de geometrie ophalen. Dit doen we op onderstaande manier.

Een GraphQL query begint met het opstellen van een query naam (op de eerste regel), deze is zelf in te vullen. De regels daaronder zijn opgesteld aan de hand van de informatie uit de documentatie.

In Stap 1 in de tutorial werd uitgelegd hoe een enkele GraphQL query doormiddel van nesting meerdere REST queries kunnen vervangen. Hierbij werd een voorbeeld genoemd waarbij van het bagverblijfsobject, via het maaktdeeluitvan_object de data van het bgtpand kan worden opgehaald. In onderstaande afbeelding is dit uitgewerkt in de vorm van een query.

Merk hierbij op dat er een peildatum is toegevoegd, dat wil zeggen dat alleen de data wordt opgehaald die op of na deze datum nog geldig is.