Punti salienti
- 01Formatta query, mutazioni, sottoscrizioni e schemi SDL utilizzando il parser ufficiale graphql.js.
- 02Convalida la sintassi e segnala la riga e la colonna esatte degli errori — nessuno schema necessario.
- 03I commenti GraphQL (#) vengono rimossi durante la formattazione; utilizza stringhe di descrizione per la documentazione che desideri preservare.
- 04Viene eseguito interamente nel tuo browser — le query API interne e gli schemi proprietari rimangono privati.
Perché formattare i documenti GraphQL?
Le query GraphQL possono diventare complesse rapidamente — frammenti annidati, variabili inline, definizioni di operazioni multiple e definizioni di tipo SDL con interfacce e direttive. La formattazione coerente rende la revisione tra colleghi più veloce e facilita l'individuazione di parentesi graffe mancanti o mancate corrispondenze di argomenti a colpo d'occhio.
Il formattatore utilizza il parser di riferimento graphql.js — lo stesso parser fornito dalla specifica GraphQL. Ciò significa che la formattazione canonica che ottieni qui corrisponde a quella prodotta dal plugin GraphQL di Prettier e dalla maggior parte degli strumenti GraphQL. Qualsiasi cosa che si analizza correttamente qui si analizzerà correttamente in Apollo, Relay e graphql-request.
Come formattare un documento GraphQL
- 01
Incolla il tuo GraphQL
Incolla una query, mutazione, sottoscrizione, frammento o definizione di schema SDL nel pannello di input.
- 02
Fai clic su Formatta
Il parser emette il documento con indentazione canonica — indentazione a due spazi, un campo per riga, allineamento coerente degli argomenti. Il risultato appare nel pannello di output.
- 03
Convalida facoltativamente
Fai clic su Convalida per confermare che il documento viene analizzato senza produrre un output formattato. Il risultato è una conferma o un elenco di errori di sintassi con numeri di riga e colonna.
- 04
Copia il risultato
Fai clic su Copia per ottenere il documento formattato. Incollalo nel tuo codebase, in una descrizione di PR o in un file di documentazione.
Sicuro per schemi interni e query API
Il parser graphql.js viene eseguito interamente nel tuo browser. Nessun testo di operazione o definizione di schema viene inviato a nessun server. Questo lo rende sicuro per formattare query che fanno riferimento a nomi di campo privati o sistemi di tipo interni che non desideri esporre a strumenti di terze parti.
La convalida qui è solo sintattica — lo strumento verifica che il documento sia un documento GraphQL valido, ma non controlla se i nomi dei campi esistono in uno schema reale, se le variabili corrispondono ai tipi di argomento o se le direttive vengono applicate correttamente. La convalida consapevole dello schema richiede che lo schema di destinazione venga caricato insieme al documento.
Domande frequenti sul formattatore GraphQL
La formattazione di GraphQL convalida rispetto a uno schema?
No — solo convalida della sintassi. Verificare se i campi e gli argomenti esistono richiede lo schema di destinazione. Questo strumento conferma che il documento è un documento GraphQL valido, nulla di più.
I commenti nel mio GraphQL verranno preservati?
No. Le righe che iniziano con # vengono rimosse dal parser. Utilizza stringhe di descrizione tra virgolette triple per la documentazione che dovrebbe sopravvivere alla formattazione.
Quale versione della specifica GraphQL è supportata?
La specifica di ottobre 2021, inclusi gli oggetti di input OneOf e la direttiva @specifiedBy.
Posso formattare definizioni di schema SDL, non solo documenti di operazione?
Sì. Le definizioni di tipo, le dichiarazioni di interfaccia, i tipi di unione, gli enum, le direttive e le descrizioni vengono tutti elaborati correttamente dal formattatore.
La query o lo schema vengono caricati da qualche parte?
No. Il parser graphql.js viene eseguito interamente nel tuo browser — nulla lascia il tuo dispositivo.