Formaterare för GraphQL
Formatera GraphQL-frågor, mutationer, fragment och scheman med den här GraphQL-formateraren. Klistra in ett dokument så parsar verktyget det med en GraphQL-parser och skriver ut det i ett standardformat: två blankstegs indrag, ett fält per rad, borttagna kommatecken mellan fält samt enhetlig placering av blanksteg i argument och variabler. Syntaxfel rapporteras, så API-utvecklare får lättlästa operationer och SDL för dokumentation, granskning och felsökning.
Vanliga frågor
Hur fungerar GraphQL Formatter?
Den parsar dokumentet till ett syntaxträd för GraphQL och skriver ut det igen i ett standardformat. Eftersom dokumentet parsas avvisas ogiltig GraphQL i stället för att formateras felaktigt.
Vad kan jag formatera?
Frågor, mutationer, prenumerationer och fragment samt schemadefinitioner i SDL, till exempel type-, input-, enum-, interface-, union- och schema-block. Du kan blanda flera definitioner i ett dokument.
Hur ser resultatet ut?
Varje urvalsmängd indenteras med två blanksteg och ett fält per rad, och kommatecken mellan fält tas bort. Argument och variabeldefinitioner får ett blanksteg efter varje kolon, till exempel user(id: $id).
Vad händer vid ett syntaxfel?
Verktyget stoppar och visar parserns meddelande, till exempel Syntax Error: Expected Name, found }. Åtgärda felet på den angivna platsen och formatera igen.
Bevaras kommentarer?
Formateraren behåller hashkommentarer (#) där parsern kan koppla dem, till exempel efter en avslutande klammerparentes. Beskrivningar inom citattecken för schematyper och fält är en del av dokumentet och bevaras alltid.
Validerar verktyget min fråga mot ett schema?
Nej, det kontrollerar bara syntaxen. Om fält och argument finns avgörs av serverns schema, så använd din GraphQL-klient eller server för att validera.
Kan jag formatera en frågesträng som kopierats från JavaScript?
Klistra bara in GraphQL-dokumentet, utan omgivande citattecken, backticks eller en gql-tagg. Escapade tecken från en JSON-payload bör avescapas först.
Kan jag ändra indraget?
Nej, formateraren använder alltid två blanksteg och har inga alternativ. Det stämmer överens med formatet som de flesta GraphQL-verktyg och dokumentation använder.
Varför omges resultatet av ett graphql-kodstaket?
Utdata returneras som ett Markdown-kodblock märkt graphql, så att det får syntaxmarkering i Markdown. Kopiera raderna mellan staketen till en .graphql-fil.
Hur stort kan mitt dokument vara?
Upp till 5 MB per körning; större indata avvisas med ett meddelande. Utdata är identiska med GraphQL-alternativet i Code Formatter.