Validera och formatera en GraphQL-fråga

Utvecklare använder GraphQL-formaterare före kodgranskning, felsökning eller överlämning till en annan medarbetare.

Validera och formatera en GraphQL-fråga så att granskning, redigering och felsökning blir enklare. Använd det gratis direkt i webbläsaren, utan konto.

Så använder du

Klistra in din GraphQL-fråga i inmatningsområdet eller importera en .graphql- eller .gql-fil.
Kontrollera att frågan är komplett och att klammerparenteserna är balanserade innan du börjar formatera.
Kör formateraren för att indentera frågan och upptäcka ett möjligt syntaxfel.
Jämför utdata med originalet för att säkerställa att frågans betydelse inte har ändrats.
Rensa innehållet innan du går vidare till en annan fråga eller fil.

Exempel

En utvecklare klistrar in en läsfråga med flera nästlade fält och formaterar den sedan inför en granskning. De kontrollerar att fälten behåller samma logiska ordning och att indenteringen gör varje block lättare att läsa.

Gränser och format

Verktyget formaterar och validerar GraphQL-syntax; det kör inte frågan och kontaktar inte något API.
Det känner inte till ditt schema, så en välindenterad fråga kan fortfarande begära fält som inte finns.
Import stöder format som .graphql, .gql, .json, .html, .css, .js, .ts, .sql och textfiler, men innehållet måste fortfarande vara giltig GraphQL.
Läs om fragment, variabler och direktiv efter formateringen för att bekräfta att inget viktigt ändrades visuellt.

Var bearbetningen sker

Formateringen sker lokalt i din webbläsare. Frågan du klistrar in eller importerar skickas inte ut och stannar på din enhet under åtgärden. Du kan förbereda en kodgranskning eller åtgärda indentering utan att skapa ett konto.

Vanliga frågor

Validerar det mot mitt schema?

Nej, det arbetar med frågans syntax. Det kan flagga felaktig skrivning, men det vet inte om fält finns i ditt schema eller om typer matchar ditt API.

Kan jag formatera en mutation eller prenumeration?

Ja, så länge texten följer GraphQL-syntax. Formateringen gäller frågans struktur, oavsett om det är en läsning, en mutation eller en prenumeration, utan att utföra operationen.

Varför formateras inte min fråga?

Ett syntaxfel, ett saknat tecken eller innehåll som inte är GraphQL kan förhindra ett rent resultat. Åtgärda den del som flaggas först och kör sedan formateraren igen på en komplett fråga.