Formátovač GraphQL
Formátujte dopyty, mutácie, fragmenty a schémy GraphQL pomocou tohto formátovača GraphQL. Vložte dokument a nástroj ho spracuje pomocou syntaktického analyzátora GraphQL a vypíše ho v štandardnom rozložení: odsadenie dvoma medzerami, jedno pole na riadok, bez čiarok medzi poľami a s jednotným formátovaním medzier pri argumentoch a premenných. Chyby syntaxe sa zobrazia, aby vývojári API získali prehľadné operácie a SDL pre dokumentáciu, revízie a ladenie.
Často kladené otázky
Ako funguje formátovač GraphQL?
Analyzuje váš dokument do syntaktického stromu GraphQL a vypíše ho späť v štandardnom rozložení. Keďže sa dokument analyzuje, neplatné GraphQL sa odmietne namiesto nesprávneho preformátovania.
Čo môžem formátovať?
Dopyty, mutácie, odbery a fragmenty, ako aj definície schém v SDL, napríklad bloky type, input, enum, interface, union a schema. V jednom dokumente môžete kombinovať viaceré definície.
Ako vyzerá výstup?
Každá množina výberov je odsadená dvoma medzerami a obsahuje jedno pole na riadok, pričom čiarky medzi poľami sa odstránia. Za každou dvojbodkou v argumentoch a definíciách premenných sa pridá medzera, napríklad user(id: $id).
Čo sa stane pri chybe syntaxe?
Nástroj sa zastaví a zobrazí správu analyzátora, napríklad Syntax Error: Expected Name, found }. Opravte označené miesto a spustite formátovanie znova.
Zachovajú sa komentáre?
Formátovač zachováva komentáre s mriežkou (#) tam, kde ich syntaktický analyzátor dokáže priradiť, napríklad za uzatváracou zloženou zátvorkou. Popisy v úvodzovkách pri typoch a poliach schémy sú súčasťou dokumentu a vždy sa zachovávajú.
Overuje dopyt podľa schémy?
Nie, kontroluje iba syntax. O tom, či polia a argumenty existujú, rozhoduje schéma vášho servera, preto na overenie použite svojho klienta alebo server GraphQL.
Môžem formátovať reťazec dopytu skopírovaný z JavaScript?
Vložte iba dokument GraphQL bez okolitých úvodzoviek, spätných apostrofov alebo značky gql. Escapované znaky z obsahu JSON najprv odescapujte.
Môžem zmeniť odsadenie?
Nie, formátovač vždy používa dve medzery a nemá žiadne možnosti nastavenia. Zodpovedá to rozloženiu, ktoré používa väčšina nástrojov a dokumentácie GraphQL.
Prečo je výsledok uzavretý v bloku kódu graphql?
Výstup sa vracia ako blok kódu Markdown označený graphql, takže sa v Markdown zobrazí so zvýraznením. Riadky medzi oddeľovačmi skopírujte do súboru .graphql.
Aký veľký môže byť môj dokument?
Najviac 5 MB na jedno spustenie; väčší vstup sa odmietne a zobrazí sa správa. Výstup je totožný s možnosťou GraphQL vo Formátovači kódu.