Viktigste punkter
- 01Formater spørringer, mutasjoner, abonnement og SDL-skjemaer ved hjelp av den offisielle graphql.js-parseren.
- 02Validerer syntaks og rapporterer eksakt linje og kolonne for feil — ingen skjema nødvendig.
- 03GraphQL-kommentarer (#) fjernes ved formatering; bruk beskrivelsestrenger for dokumentasjon du vil bevare.
- 04Kjøres helt i nettleseren — interne API-spørringer og proprietære skjemaer forblir private.
Hvorfor formatere GraphQL-dokumenter?
GraphQL-spørringer kan bli komplekse raskt — nestet fragmenter, inline-variabler, flere operasjonsdefinisjonerte og SDL-typedefinisjonene med grensesnitt og direktiver. Konsistent formatering gjør peer-review raskere og gjør det lettere å få øye på manglende avsluttende parenteser eller argumentfeilmatch med ett øyekast.
Formateren bruker referanser graphql.js-parseren — samme parser som GraphQL-spesifikasjonen leveres med. Det betyr at den kanoniske formateringen du får her samsvarer med det Prettier's GraphQL-plugin og de fleste GraphQL-verktøy produserer. Alt som analyseres rent her vil analyseres rent i Apollo, Relay og graphql-request.
Hvordan formatere et GraphQL-dokument
- 01
Lim inn GraphQL-en
Lim inn en spørring, mutasjon, abonnement, fragment eller SDL-skjemadefinisjon inn i inndatapanelet.
- 02
Klikk Formater
Parseren utsender dokumentet med kanonisk innrykk — to-mellomrom innrykk, ett felt per linje, konsistent argumentjustering. Resultatet vises i utdatapanelet.
- 03
Valider valgfritt
Klikk Valider for å bekrefte at dokumentet analyseres uten å produsere et formatert utdata. Resultatet er en bekreftelse eller en liste over syntaksfeil med linje- og kolonnummer.
- 04
Kopier resultatet
Klikk Kopier for å få det formaterte dokumentet. Lim det inn i kodebassen, en PR-beskrivelse eller en dokumentasjonsfil.
Trygt for interne skjemaer og API-spørringer
Graphql.js-parseren kjøres helt i nettleseren. Ingen operasjonstekst eller skjemadefinisjon sendes til noen server. Det gjør det trygt å formatere spørringer som refererer til private feltnavn eller interne typesystemer du ikke vil eksponere for tredjeparts verktøy.
Validering her er syntaktisk bare — verktøyet sjekker at dokumentet er et gyldig GraphQL-dokument, men det sjekker ikke om feltnavn finnes i et reelt skjema, om variabler samsvarer med argumenttyper, eller om direktiver brukes riktig. Skjemaverifiseringsbevisst validering krever at målskjemaet lastes sammen med dokumentet.
GraphQL Formatter FAQ
Validerer GraphQL-formatering mot et skjema?
Nei — bare syntaksvalidering. Å kontrollere om felt og argumenter finnes krever målskjemaet. Dette verktøyet bekrefter at dokumentet er et gyldig GraphQL-dokument, ingenting mer.
Vil kommentarer i GraphQL-en min bevares?
Nei. Linjer som starter med # fjernes av parseren. Bruk trippelsiterte beskrivelsestrenger for dokumentasjon som skal overleve formatering.
Hvilken GraphQL spec-versjon støttes?
Oktober 2021-spesifikasjonen, inkludert OneOf-inndataobjekter og @specifiedBy-direktivet.
Kan jeg formatere SDL-skjemadefinisjonene, ikke bare operasjonsdokumenter?
Ja. Typedefinisjonene, grensesnittserklæringene, uniontyper, opptellingsverdiene, direktiver og beskrivelseskriving rund-reises riktig gjennom formateren.
Blir spørringen eller skjemaet lastet opp noe sted?
Nei. Graphql.js-parseren kjøres helt i nettleseren — ingenting forlater enheten din.