Viktiga punkter
- 01Formaterar frågor, mutationer, prenumerationer och SDL-scheman med hjälp av den officiella graphql.js-tolken.
- 02Validerar syntax och rapporterar exakt rad och kolumn för fel — inget schema behövs.
- 03GraphQL-kommentarer (#) tas bort vid formatering; använd beskrivningssträngar för dokumentation du vill bevara.
- 04Körs helt i din webbläsare — interna API-frågor och proprietära scheman förblir privata.
Varför formatera GraphQL-dokument?
GraphQL-frågor kan bli komplexa snabbt — kapslade fragment, inline-variabler, flera operationsdefinitioner och SDL-typdefiniering med gränssnitt och direktiv. Konsekvent formatering gör peer review snabbare och gör det lättare att se saknade avslutande parenteser eller argumentmatchningar på ett ögonblick.
Formataren använder referens-graphql.js-tolken — samma tolk som GraphQL-specifikationen skickar med. Det innebär att den kanoniska formateringen du får här matchar vad Prettier:s GraphQL-plugin och de flesta GraphQL-verktyg producerar. Allt som tolkar rent här kommer att tolka rent i Apollo, Relay och graphql-request.
Hur man formaterar ett GraphQL-dokument
- 01
Klistra in din GraphQL
Klistra in en fråga, mutation, prenumeration, fragment eller SDL-schemadefinition i indatapanelen.
- 02
Klicka Formatera
Tolken emitterar dokumentet med kanonisk indentation — två-mellanslag indentation, ett fält per rad, konsekvent argumentjustering. Resultatet visas i utmatapanelen.
- 03
Validera eventuellt
Klicka Validera för att bekräfta dokumentet tolkas utan att producera en formaterad utmatning. Resultatet är en bekräftelse eller en lista över syntaxfel med rad- och kolumnnummer.
- 04
Kopiera resultatet
Klicka Kopiera för att ta det formaterade dokumentet. Klistra in i din kodlager, en PR-beskrivning eller en dokumentationsfil.
Säkert för interna scheman och API-frågor
Graphql.js-tolken körs helt i din webbläsare. Ingen operationstext eller schemadefinition skickas till någon server. Det gör det säkert att formatera frågor som refererar till privata fältnamn eller interna typsystem du inte vill utsätta för tredje partsverktyg.
Validering här är endast syntaktisk — verktyget kontrollerar att dokumentet är ett giltigt GraphQL-dokument, men det kontrollerar inte om fältnamn finns i ett verkligt schema, om variabler matchar argumenttyper eller om direktiv tillämpas korrekt. Schemamedveten validering kräver att målschemat ladda tillsammans med dokumentet.
GraphQL Formatter FAQ
Validerar GraphQL-formatering mot ett schema?
Nej — endast syntaxvalidering. Att kontrollera om fält och argument finns kräver målschemat. Det här verktyget bekräftar dokumentet är ett giltigt GraphQL-dokument, inget mer.
Kommer kommentarer i min GraphQL att bevaras?
Nej. Rader som börjar med # tas bort av tolken. Använd trippel-citerade beskrivningssträngar för dokumentation som ska överleva formatering.
Vilken GraphQL-specversion stöds?
Oktober 2021-specifikationen, inklusive OneOf-indataobjekt och @specifiedBy-direktiv.
Kan jag formatera SDL-schemadefinitioner, inte bara operationsdokument?
Ja. Typdefiniering, gränssnittsdeklaration, unionstyper, uppräkningar, direktiv och beskrivningar rundturar alla korrekt genom formatern.
Är frågan eller schemat uppladdat någonstans?
Nej. Graphql.js-tolken körs helt i din webbläsare — ingenting lämnar din enhet.