Belangrijkste punten
- 01Maakt query's, mutaties, abonnementen en SDL-schema's op met behulp van de officiële graphql.js-parser.
- 02Valideert syntaxis en rapporteert exacte regel- en kolomnummers voor fouten — geen schema nodig.
- 03GraphQL-opmerkingen (#) worden verwijderd bij opmaak; gebruik beschrijvingsstrings voor documentatie die je wilt behouden.
- 04Draait volledig in je browser — interne API-query's en propriëtaire schema's blijven privé.
Waarom GraphQL-documenten opmaken?
GraphQL-query's kunnen snel ingewikkeld worden — geneste fragmenten, inline-variabelen, meerdere operatiedefinities en SDL-typedefinities met interfaces en richtlijnen. Consistente opmaak maakt peer review sneller en maakt het gemakkelijker om ontbrekende sluithaakjes of argumentverschillen in één oogopslag op te spotten.
De formatter gebruikt de referentie graphql.js-parser — dezelfde parser die de GraphQL-specificatie meelevert. Dit betekent dat de standaardopmaak die je hier krijgt, overeenkomt met wat de GraphQL-plugin van Prettier en de meeste GraphQL-tools produceren. Alles wat hier schoon parseert, parseert ook schoon in Apollo, Relay en graphql-request.
Een GraphQL-document opmaken
- 01
Plak je GraphQL
Plak een query, mutatie, abonnement, fragment of SDL-schemadefinitie in het invoerpaneel.
- 02
Klik op Opmaken
De parser geeft het document uit met standaard inspringing — twee spaties inspringing, één veld per regel, consistente uitlijning van argumenten. Het resultaat verschijnt in het uitvoerpaneel.
- 03
Valideer optioneel
Klik op Valideren om te bevestigen dat het document zonder opmaakuitvoer parseert. Het resultaat is een bevestiging of een lijst met syntaxisfouten met regel- en kolomnummers.
- 04
Kopieer het resultaat
Klik op Kopiëren om het opgemaakte document te pakken. Plak het in je codebase, een PR-beschrijving of een documentatiebestand.
Veilig voor interne schema's en API-query's
De graphql.js-parser draait volledig in je browser. Geen operatietekst of schemadefinitie wordt naar een server verzonden. Dit maakt het veilig om query's op te maken die verwijzen naar privéveldnamen of interne typesystemen die je niet aan tools van derden wilt blootstellen.
Validatie hier is alleen syntactisch — het hulpmiddel controleert of het document een geldig GraphQL-document is, maar het controleert niet of veldnamen in een echt schema bestaan, of variabelen overeenkomen met argumenttypen, of richtlijnen correct worden toegepast. Schemaaware-validatie vereist dat het doelschema naast het document wordt geladen.
Veelgestelde vragen over GraphQL Formatter
Valideert GraphQL-opmaak tegen een schema?
Nee — alleen syntaxisvalidatie. Controleren of velden en argumenten bestaan, vereist het doelschema. Dit hulpmiddel bevestigt dat het document een geldig GraphQL-document is, niets meer.
Blijven opmerkingen in mijn GraphQL behouden?
Nee. Regels die beginnen met # worden door de parser verwijderd. Gebruik triple-quoted beschrijvingsstrings voor documentatie die opmaak moet overleven.
Welke GraphQL-specificatieversie wordt ondersteund?
De specificatie van oktober 2021, inclusief OneOf-invoer objecten en de @specifiedBy-richtlijn.
Kan ik SDL-schemadefinities opmaken, niet alleen operatiedocumenten?
Ja. Typedefinities, interfacedeklaraties, unietype's, enums, richtlijnen en beschrijvingen worden allemaal correct door de formatter verwerkt.
Wordt de query of het schema ergens geüpload?
Nee. De graphql.js-parser draait volledig in je browser — niets verlaat je apparaat.