Valideer en formatteer een GraphQL-query

Ontwikkelaars gebruiken GraphQL-formatter vóór een codereview, foutopsporing of overdracht aan een andere bijdrager.

Valideer en formatteer een GraphQL-query, zodat nakijken, aanpassen en fouten zoeken eenvoudiger worden. Gebruik het in je browser zonder account.

Hoe te gebruiken

Plak uw GraphQL-query in het invoergebied of importeer een bestand met de extensie .graphql of .gql.
Controleer voordat u begint met formatteren of de query volledig is en de accolades in balans zijn.
Start de formatter om de query te inspringen en een mogelijke syntaxfout op te sporen.
Vergelijk de uitvoer met het origineel om zeker te zijn dat de betekenis van de query niet is veranderd.
Maak de inhoud leeg voordat u verdergaat met een andere query of een ander bestand.

Voorbeeld

Een ontwikkelaar plakt een leesquery met verschillende geneste velden en formatteert deze voor een beoordeling. Hij controleert of de velden dezelfde logische volgorde behouden en of de inspringing elk blok gemakkelijker leesbaar maakt.

Limieten en formaten

De tool formatteert en valideert GraphQL-syntax; hij voert de query niet uit en neemt geen contact op met een API.
Hij kent uw schema niet, dus een goed ingesprongen query kan nog steeds velden opvragen die niet bestaan.
Import ondersteunt indelingen zoals .graphql, .gql, .json, .html, .css, .js, .ts, .sql en tekstbestanden, maar de inhoud moet nog steeds geldige GraphQL zijn.
Lees na het formatteren fragmenten, variabelen en directives opnieuw om te bevestigen dat niets belangrijks visueel is gewijzigd.

Waar de verwerking gebeurt

Het formatteren gebeurt lokaal in uw browser. De query die u plakt of importeert, wordt niet naar buiten gestuurd en blijft tijdens de bewerking op uw apparaat. U kunt een codebeoordeling voorbereiden of de inspringing corrigeren zonder een account aan te maken.

Veelgestelde vragen

Valideert het tegen mijn schema?

Nee, het werkt op de syntax van de query. Het kan onjuiste schrijfwijze signaleren, maar weet niet of velden in uw schema bestaan of of typen bij uw API passen.

Kan ik een mutation of subscription formatteren?

Ja, zolang de tekst de GraphQL-syntax volgt. Het formatteren geldt voor de structuur van de query, of het nu een leesquery, een mutation of een subscription is, zonder de bewerking uit te voeren.

Waarom wordt mijn query niet geformatteerd?

Een syntaxfout, een ontbrekend teken of inhoud die geen GraphQL is, kunnen een schoon resultaat verhinderen. Los eerst het gemarkeerde deel op en voer de formatter daarna opnieuw uit op een volledige query.