Formátovač GraphQL
Formátujte dotazy GraphQL, mutace, fragmenty a schémata pomocí tohoto formátovače GraphQL. Vložte dokument a nástroj ho zpracuje pomocí parseru GraphQL a vypíše ve standardním rozvržení: odsazení o dvě mezery, jedno pole na řádek, odstraněné čárky mezi poli a jednotně formátované mezery u argumentů a proměnných. Syntaktické chyby se ohlásí, takže vývojáři API získají přehledné operace a SDL pro dokumentaci, revize a ladění.
Často kladené otázky
Jak funguje formátovač GraphQL?
Dokument zpracuje do syntaktického stromu GraphQL a znovu ho vypíše ve standardním rozvržení. Protože se dokument nejprve zpracuje, neplatné GraphQL se odmítne místo nesprávného přeformátování.
Co mohu formátovat?
Dotazy, mutace, předplatná a fragmenty, stejně jako definice schématu v SDL, například bloky type, input, enum, interface, union a schema. V jednom dokumentu můžete kombinovat několik definic.
Jak vypadá výstup?
Každá výběrová množina je odsazená o dvě mezery, s jedním polem na řádek, a čárky mezi poli se odstraní. Argumenty a definice proměnných mají za každou dvojtečkou mezeru, například user(id: $id).
Co se stane při syntaktické chybě?
Nástroj se zastaví a zobrazí zprávu parseru, například „Chyba syntaxe: Očekáváno Name, nalezeno }“. Opravte uvedené místo a spusťte formátování znovu.
Zachovají se komentáře?
Formátovač zachovává komentáře s mřížkou (#) tam, kde je k nim parser může přiřadit, například za uzavírací složenou závorkou. Popisy v uvozovkách u typů a polí schématu jsou součástí dokumentu a vždy se zachovávají.
Ověřuje dotaz vůči schématu?
Ne, kontroluje pouze syntaxi. O tom, zda pole a argumenty existují, rozhoduje schéma vašeho serveru, proto je ověřte pomocí klienta nebo serveru GraphQL.
Mohu naformátovat řetězec dotazu zkopírovaný z JavaScript?
Vložte pouze dokument GraphQL, bez uvozovek, zpětných apostrofů nebo značky gql okolo. Řídicí znaky v datové části JSON nejprve zrušte.
Mohu změnit odsazení?
Ne, formátovač vždy používá dvě mezery a nemá žádné možnosti nastavení. Odpovídá to rozložení, které používá většina nástrojů a dokumentace GraphQL.
Proč je výsledek uzavřený v bloku kódu graphql?
Výstup se vrací jako blok kódu Markdown označený graphql, takže se v Markdown zobrazí se zvýrazněním syntaxe. Pro soubor .graphql zkopírujte řádky mezi ohraničujícími značkami.
Jak velký může být můj dokument?
Až 5 MB na jedno spuštění; větší vstup se odmítne se zprávou. Výstup je totožný s možností GraphQL ve Formátovači kódu.