Vigtigste punkter
- 01Formaterer forespørgsler, mutationer, abonnementer og SDL-skemaer ved hjælp af den officielle graphql.js-parser.
- 02Validerer syntaks og rapporterer præcis linje og kolonne til fejl — ingen skema påkrævet.
- 03GraphQL-kommentarer (#) fjernes på formatering; brug beskrivelsesstrenge til dokumentation du ønsker at bevare.
- 04Kørende fuldstændigt i din browser — indre API-forespørgsler og proprietære skemaer forbliver private.
Hvorfor formaterer du GraphQL-dokumenter?
GraphQL-forespørgsler kan blive komplekse hurtigt — indlejrede fragmenter, inline-variabler, flere operationsdefinitioner og SDL-type-definitioner med interfaces og direktiver. Konsistent formatering gør peer review hurtigere og gør det nemmere at få øjet på manglende lukkekrøllede eller argumentmismatches med et øjekast.
Formateren bruger reference graphql.js-parseren — den samme parser GraphQL-specifikationen leveres med. Det betyder, at den kanoniske formatering du får her matcher hvad Prettier's GraphQL-plugin og de fleste GraphQL-værktøjer producerer. Alt der parser rent her, vil parse rent i Apollo, Relay og graphql-request.
Sådan formaterer du et GraphQL-dokument
- 01
Indsæt din GraphQL
Indsæt en forespørgsel, mutation, abonnement, fragment eller SDL-skemadefinition i input-panelet.
- 02
Klik Formater
Parseren emitterer dokumentet med kanonisk indrykninger — to-mellemrums-indrykninger, et felt pr. linje, konsistent argument-justering. Resultatet vises i output-panelet.
- 03
Validér valgfrit
Klik Validér for at bekræfte dokumentet parser uden at producere et formateret output. Resultatet er en bekræftelse eller en liste over syntaksfejl med linje- og kolonnenumre.
- 04
Kopier resultatet
Klik Kopier for at få det formaterede dokument. Indsæt det i din kodebasis, en PR-beskrivelse eller en dokumentationsfil.
Sikkert til indre skemaer og API-forespørgsler
graphql.js-parseren kørende fuldstændigt i din browser. Ingen operationstekst eller skemadefinition sendes til nogen server. Det gør det sikkert at formatere forespørgsler der henviser til private feltnavne eller indre typesystemer du ikke ønsker eksponeret til tredjeparts-værktøjer.
Validering her er kun syntaktisk — værktøjet kontrollerer at dokumentet er et gyldigt GraphQL-dokument, men det kontrollerer ikke om feltnavne eksisterer i et rigtigt skema, om variabler matcher argument-typer eller om direktiver anvendes korrekt. Skema-klar validering kræver at target-skemaet indlæses sammen med dokumentet.
GraphQL Formatter FAQ
Validerer GraphQL-formatering mod et skema?
Nej — kun syntaksvalidering. Kontrol af om felter og argumenter eksisterer kræver target-skemaet. Dette værktøj bekræfter dokumentet er et gyldigt GraphQL-dokument, intet mere.
Vil kommentarer i min GraphQL blive bevaret?
Nej. Linjer startende med # fjernes af parseren. Brug triple-citerede beskrivelsesstrenge til dokumentation der skal overleve formatering.
Hvilken GraphQL spec-version understøttes?
Oktober 2021-specifikationen, inklusive OneOf input-objekter og @specifiedBy-direktivet.
Kan jeg formatere SDL-skemadefinitioner, ikke bare operations-dokumenter?
Ja. Type-definitioner, interface-deklarationer, union-typer, enums, direktiver og beskrivelser round-trip alle korrekt gennem formateren.
Bliver forespørgslen eller skemaet uploadet nogen steder?
Nej. graphql.js-parseren kørende fuldstændigt i din browser — intet forlader din enhed.