Formattatore GraphQL
Formattate query, mutation, fragment e schemi GraphQL con questo formattatore GraphQL. Incollate un documento: lo strumento lo analizza con un parser GraphQL e lo stampa in un formato standard, con rientro di due spazi, un campo per riga, senza virgole tra i campi e con spaziatura uniforme per argomenti e variabili. Gli errori di sintassi vengono segnalati, così gli sviluppatori API ottengono operazioni leggibili e SDL per la documentazione, le revisioni e il debug.
Domande frequenti
Come funziona il Formatter GraphQL?
Analizza il documento creando un albero sintattico GraphQL, quindi lo stampa con un layout standard. Poiché il documento viene analizzato, GraphQL non valido viene rifiutato anziché formattato in modo errato.
Che cosa posso formattare?
Query, mutation, subscription e fragment, oltre alle definizioni dello schema in SDL, come blocchi type, input, enum, interface, union e schema. Potete includere più definizioni nello stesso documento.
Che aspetto ha il risultato?
Ogni set di selezione è indentato con due spazi e un campo per riga; le virgole tra i campi vengono rimosse. Dopo ogni due punti negli argomenti e nelle definizioni delle variabili viene inserito uno spazio, ad esempio user(id: $id).
Cosa succede in caso di errore di sintassi?
Lo strumento si ferma e mostra il messaggio del parser, ad esempio Syntax Error: Expected Name, found }. Correggete il punto indicato e formattate di nuovo.
I commenti vengono mantenuti?
Il formattatore mantiene i commenti con cancelletto (#) nei punti in cui il parser può associarli, per esempio dopo una parentesi graffa di chiusura. Le descrizioni tra virgolette dei tipi e dei campi dello schema fanno parte del documento e vengono sempre preservate.
Convalida la mia query rispetto a uno schema?
No, controlla solo la sintassi. È lo schema del server a determinare se i campi e gli argomenti esistono; usate quindi il vostro client o server GraphQL per convalidare.
Posso formattare una stringa di query copiata da JavaScript?
Incollate solo il documento GraphQL, senza virgolette, backtick o tag gql circostanti. I caratteri di escape di un payload JSON devono prima essere convertiti nei caratteri corrispondenti.
Posso cambiare l'indentazione?
No, il formatter usa sempre due spazi e non offre opzioni. È il layout usato dalla maggior parte degli strumenti e della documentazione GraphQL.
Perché il risultato è racchiuso in un blocco di codice graphql?
L'output viene restituito come blocco di codice Markdown contrassegnato come graphql, quindi viene visualizzato con l'evidenziazione della sintassi in Markdown. Copiate le righe tra i delimitatori per creare un file .graphql.
Qual è la dimensione massima del documento?
Fino a 5 MB per esecuzione; gli input più grandi vengono rifiutati con un messaggio. L'output è identico a quello dell'opzione GraphQL del Code Formatter.