Κύρια σημεία
- 01Μορφοποιεί τα queries, mutations, subscriptions και SDL schemas χρησιμοποιώντας τον επίσημο graphql.js parser.
- 02Επικυρώνει τη σύνταξη και αναφέρει ακριβή γραμμή και στήλη για σφάλματα — χωρίς schema που απαιτείται.
- 03Τα GraphQL comments (#) αφαιρούνται κατά τη μορφοποίηση. χρησιμοποιήστε description strings για τεκμηρίωση που θέλετε να διατηρήσετε.
- 04Τρέχει εντελώς στο πρόγραμμα περιήγησής σας — τα εσωτερικά API queries και proprietary schemas παραμένουν ιδιωτικά.
Γιατί να μορφοποιήσετε GraphQL Documents;
Τα GraphQL queries μπορούν να γίνουν σύνθετα γρήγορα — nested fragments, inline variables, πολλαπλές operation definitions και SDL type definitions με interfaces και directives. Η συνεπής μορφοποίηση κάνει τη peer review γρηγορότερη και διευκολύνει τον εντοπισμό missing closing braces ή argument mismatches με ματιά.
Ο formatter χρησιμοποιεί τον reference graphql.js parser — τον ίδιο parser που η GraphQL specification αποστέλλει. Αυτό σημαίνει ότι η κανονική μορφοποίηση που παίρνετε εδώ ταιριάζει με αυτό που παράγουν το Prettier's GraphQL plugin και η περισσότερη GraphQL tooling. Οτιδήποτε που αναλύεται καθαρά εδώ θα αναλύεται καθαρά σε Apollo, Relay και graphql-request.
Πώς να μορφοποιήσετε ένα GraphQL Document
- 01
Επικολλήστε το GraphQL σας
Επικολλήστε ένα query, mutation, subscription, fragment ή SDL schema definition στο πάνελ εισόδου.
- 02
Κάντε κλικ Format
Ο parser εκπέμπει το document με κανονικές εσοχές — δύο-χώρο κενό, ένα field ανά γραμμή, συνεπή ευθυγράμμιση argument. Το αποτέλεσμα εμφανίζεται στο πάνελ εξόδου.
- 03
Επικυρώστε προαιρετικά
Κάντε κλικ Validate για να επιβεβαιώσετε ότι το document αναλύεται χωρίς να παράγει μορφοποιημένο output. Το αποτέλεσμα είναι μια επιβεβαίωση ή μια λίστα σφαλμάτων σύνταξης με αριθμούς γραμμής και στήλης.
- 04
Αντιγράψτε το αποτέλεσμα
Κάντε κλικ Copy για να πάρετε το μορφοποιημένο document. Επικολλήστε το στο codebase σας, μια PR description ή ένα documentation file.
Ασφαλές για εσωτερικά Schemas και API Queries
Ο graphql.js parser τρέχει εντελώς στο πρόγραμμα περιήγησής σας. Κανένα operation text ή schema definition δεν στέλνεται σε κανέναν server. Αυτό το καθιστά ασφαλές για μορφοποίηση queries που αναφέρονται σε private field names ή εσωτερικά type systems που δεν θέλετε να εκτεθούν σε third-party εργαλεία.
Η επικύρωση εδώ είναι μόνο συντακτική — το εργαλείο ελέγχει ότι το document είναι ένα έγκυρο GraphQL document, αλλά δεν ελέγχει αν τα ονόματα fields υπάρχουν σε ένα real schema, αν οι μεταβλητές ταιριάζουν τα είδη arguments ή αν τα directives εφαρμόζονται σωστά. Η schema-aware validation απαιτεί το target schema να φορτωθεί παράλληλα με το document.
Συνήθεις ερωτήσεις GraphQL Formatter
Επικυρώνει η μορφοποίηση GraphQL έναντι ενός schema;
Όχι — μόνο syntax validation. Ο έλεγχος αν τα fields και τα arguments υπάρχουν απαιτεί το target schema. Αυτό το εργαλείο επιβεβαιώνει ότι το document είναι ένα έγκυρο GraphQL document, τίποτα περισσότερο.
Θα διατηρηθούν τα σχόλια στο GraphQL μου;
Όχι. Οι γραμμές που ξεκινούν με # αφαιρούνται από τον parser. Χρησιμοποιήστε triple-quoted description strings για τεκμηρίωση που πρέπει να επιζήσει της μορφοποίησης.
Ποια έκδοση GraphQL spec υποστηρίζεται;
Η σκευασματογραφία Οκτωβρίου 2021, συμπεριλαμβανομένων των OneOf input objects και της @specifiedBy directive.
Μπορώ να μορφοποιήσω SDL schema definitions, όχι μόνο operation documents;
Ναι. Οι ορισμοί τύπου, οι δηλώσεις διεπαφής, οι τύποι union, τα enums, τα directives και οι περιγραφές όλοι κάνουν round-trip σωστά μέσω του formatter.
Φορτώνεται το query ή το schema κάπου;
Όχι. Ο graphql.js parser τρέχει εντελώς στο πρόγραμμα περιήγησής σας — τίποτα δεν εγκαταλείπει τη συσκευή σας.