De API Verkenner is een IDE in de browser om de GraphQL API van een project te verkennen. Archie Core-ontwikkelaars kunnen er eenvoudig GraphQL-query’s mee bouken en uitvoeren vanuit de werkruimte.

De API Verkenner gebruikt uw echte, live productiedata.

---

Introspectie

Een GraphQL-schema heeft een ingebouwd introspectiesysteem dat de structuur van het schema publiceert. Zo kan de API Verkenner krachtige automatische aanvulling bieden bij het schrijven van GraphQL-query’s.

Zodra u zich in het items-blok bevindt, typt u “em”. Vervolgens kunt u eenvoudig het veld email zien en selecteren uit de beschikbare bewerkingen in de API. De automatische aanvulling is contextueel ten opzichte van waar u zich in de query bevindt en filtert opties op basis van wat u typt.

Om het menu voor automatische aanvulling handmatig te openen en beschikbare opties te zien, gebruikt u de toetscombinatie [Shift] + [SPATIE]. Er verschijnt een contextmenu waarmee u het gewenste veld kunt kiezen, zoals items, uit de lijst.

Introspectie helpt ook bij het herkennen van fouten in query’s. Het systeem signaleert wanneer typen niet beschikbaar of verkeerd geconfigureerd zijn — bijvoorbeeld Number zou String moeten zijn, veld niet beschikbaar op de tabel, evenals validaties. Gebruik daarom in de API Verkenner de muis over rode golvende lijnen om fouttooltips te zien.

Toegang tot API-documentatie

De API Verkenner bevat een ingebouwde schema-referentie om uw datamodel te begrijpen tijdens het schrijven van query’s. Er zijn twee manieren om dit te openen:

1. Het documentatiepaneel

Klik op de knop Documentation rechtsboven in de werkbalk. Er verschijnt een zijbalk links waarin u alle beschikbare Queries, Mutations en Types kunt doorbladeren en doorzoeken.

2. Contextuele snelle navigatie

Zoals in de afbeelding kunt u direct naar de documentatie van een specifiek veld springen dat u typt:

• Beweeg de muis over een veldnaam (bijv. cities) in de editor. Er verschijnt een tooltip met het retourtype (bijv. CitiesConnection).
• Klik op de typenaam in de tooltip.
• Het documentatiepaneel opent automatisch en gaat naar die typedefinitie, met alle beschikbare subvelden (zoals items, count, aggregates) en hun beschrijvingen.

Composer

De Composer is een visuele querybouwer die standaard meestal links in de API Verkenner staat. U selecteert velden en argumenten om automatisch geldige GraphQL-syntax te genereren.

Als u het paneel hebt gesloten of het niet ziet, kunt u het zo weer openen:

• Zoek de knop Composer rechtsboven in de werkbalk.
• Deze staat direct naast de knop Documentation.
• Een klik schakelt de Composer-zijbalk en brengt de visuele editor weer in beeld.

Open cities en vink de optie count aan. De volgende query vult het tekstgebied; u kunt deze uitvoeren om te zien hoeveel steden er zijn.

query MyQuery {
  cities {
    items {
      nameCity
    }
  }
}