Formatter pentru GraphQL
Formatați interogări, mutații, fragmente și scheme GraphQL cu acest formatter pentru GraphQL. Lipiți un document, iar instrumentul îl analizează cu un parser GraphQL și îl afișează într-un format standard: indentare de două spații, câte un câmp pe rând, fără virgule între câmpuri și cu spațiere uniformă pentru argumente și variabile. Erorile de sintaxă sunt raportate, astfel că dezvoltatorii API obțin operațiuni și SDL ușor de citit pentru documentație, revizuiri și depanare.
Întrebări frecvente
Cum funcționează formatterul GraphQL?
Analizează documentul într-un arbore sintactic GraphQL și îl afișează din nou într-un format standard. Deoarece documentul este analizat, GraphQL invalid este respins în loc să fie reformata incorect.
Ce pot formata?
Interogări, mutații, abonamente și fragmente, precum și definiții de schemă în SDL, cum ar fi blocuri de tip, input, enum, interfață, uniune și schemă. Puteți combina mai multe definiții într-un singur document.
Cum arată rezultatul?
Fiecare set de selecție este indentat cu două spații, cu un câmp pe linie, iar virgulele dintre câmpuri sunt eliminate. Argumentele și definițiile variabilelor au un spațiu după fiecare două puncte, de exemplu user(id: $id).
Ce se întâmplă în cazul unei erori de sintaxă?
Instrumentul se oprește și afișează mesajul parserului, de exemplu Syntax Error: Expected Name, found }. Corectați locul semnalat și formatați din nou.
Sunt păstrate comentariile?
Formatorul păstrează comentariile cu diez (#) acolo unde parserul le poate asocia, de exemplu după o acoladă de închidere. Descrierile între ghilimele ale tipurilor și câmpurilor din schemă fac parte din document și sunt întotdeauna păstrate.
Validează interogarea în raport cu o schemă?
Nu, verifică doar sintaxa. Existența câmpurilor și argumentelor este stabilită de schema serverului dvs., așa că folosiți clientul sau serverul GraphQL pentru validare.
Pot formata un șir de interogare copiat din JavaScript?
Lipiți doar documentul GraphQL, fără ghilimele, backtickuri sau o etichetă gql în jur. Caracterele escape dintr-un payload JSON trebuie mai întâi de-escape-uite.
Pot schimba indentarea?
Nu, formatterul folosește întotdeauna două spații și nu are opțiuni. Astfel se obține formatul folosit de majoritatea instrumentelor și documentației GraphQL.
De ce este rezultatul încadrat într-un bloc de cod graphql?
Rezultatul este returnat ca bloc de cod Markdown etichetat graphql, astfel încât să fie afișat cu evidențierea sintaxei în Markdown. Copiați liniile dintre delimitatoare pentru un fișier .graphql.
Cât de mare poate fi documentul meu?
Până la 5 MB per rulare; intrările mai mari sunt respinse cu un mesaj. Rezultatul este identic cu opțiunea GraphQL din Code Formatter.