Eenvoudige GraphQL-queries uitvoeren

Welkom bij het uitvoeren van GraphQL-query's! In deze les leer je hoe je gegevens ophaalt van een GraphQL-server.

Een GraphQL-query is de manier waarop een clienttoepassing de server om gegevens vraagt. In tegenstelling tot traditionele REST-API's, waarbij je vaak vaste gegevensstructuren ontvangt, kun je met GraphQL precies aangeven welke gegevens je nodig hebt.

Voor het uitvoeren van query's gebruiken we vaak interactieve hulpmiddelen. Twee populaire opties zijn GraphiQL en GraphQL Playground.

• Dit zijn browsergebaseerde IDE's (Integrated Development Environments).
• Ze bieden functies zoals schemaverkenning, automatische aanvulling van query's en documentatie.
• Ze maken verbinding met het eindpunt van je GraphQL-server om query's te verzenden en resultaten weer te geven.

Een GraphQL-query begint met het selecteren van velden uit het hoofdtype Query. Je geeft de gewenste velden op en de server retourneert alleen die gegevens.

Het sleutelwoord query is optioneel voor eenvoudige query's, maar het is een goede gewoonte om het voor de duidelijkheid en voor het benoemen van bewerkingen op te nemen.

Stel dat ons schema een type Book heeft met de velden title en author. Als we een lijst met alle boeken en hun titels en auteurs willen ophalen, schrijven we:

Let op: de accolades {} definiëren een selectieset voor het veld allBooks.

Een van de sterke punten van GraphQL is dat je geneste gegevens in één verzoek kunt opvragen. Als ons veld author een objecttype is met eigen velden, zoals name en nationality, kunnen we die ook selecteren:

Hiermee haal je boeken en de namen en nationaliteiten van hun auteurs allemaal tegelijk op!

Je kunt argumenten aan velden doorgeven om te filteren, te pagineren of een specifiek item op te geven. Argumenten worden in het schema gedefinieerd en werken als functieparameters.

Als je bijvoorbeeld een specifiek boek op ID wilt ophalen:

Hier is id: "1" een argument dat aan het veld bookById wordt doorgegeven.

Wat doe je als je hetzelfde veld meerdere keren met verschillende argumenten wilt opvragen? Met aliassen kun je het resultaat van een veld hernoemen.

Zo voorkom je conflicten in het JSON-antwoord wanneer dezelfde veldnaam meerdere keren voorkomt:

De resultaten heten firstBook en secondBook.

Fragmenten zijn herbruikbare eenheden met selectielogica. Hiermee kun je een set velden één keer definiëren en deze vervolgens in meerdere query's of binnen dezelfde query hergebruiken.

Dit is handig voor complexe query's of wanneer verschillende delen van je gebruikersinterface dezelfde subset van gegevens nodig hebben:

Met de syntaxis ...BookDetails worden de velden uit het fragment in de query opgenomen.

Je query's een bewerkingsnaam geven, zoals GetBookDetails, is handig voor foutopsporing en logboekregistratie aan de serverkant.

Je kunt ook variabelen definiëren om dynamische gegevens aan je query's door te geven, waardoor ze flexibeler worden:

De variabele $bookId wordt afzonderlijk aangeleverd, meestal als een JSON-object, bijvoorbeeld {"bookId": "3"}, in je hulpmiddel voor query's.

Houd deze tips in gedachten bij het opstellen van je query's:

• Wees specifiek: vraag alleen de gegevens op die je echt nodig hebt.
• Gebruik fragmenten: voor herbruikbare selectiesets, vooral in verschillende delen van je toepassing.
• Geef bewerkingen een naam: dit helpt bij foutopsporing en bewaking.
• Gebruik variabelen: voor dynamische argumenten, in plaats van waarden rechtstreeks in de querytekenreeks vast te leggen.
• Verken het schema: gebruik de documentatieverkenner van GraphiQL/Playground om te zien welke velden en argumenten beschikbaar zijn.

Goed gedaan! Je hebt de basis van het uitvoeren van GraphQL-query's behandeld:

• Hoe query's precies aangeven welke gegevens moeten worden opgehaald.
• Het gebruik van hulpmiddelen zoals GraphiQL en GraphQL Playground.
• De basisstructuur, inclusief het selecteren van velden en geneste gegevens.
• Het doorgeven van argumenten aan velden om te filteren.
• Het gebruik van aliassen om veldresultaten te hernoemen.
• Het benutten van fragmenten voor herbruikbare selectiesets.
• Het belang van bewerkingsnamen en variabelen.

Je bent nu klaar om efficiënt gegevens op te halen!