Ένας μορφοποιητής JSON και ένας επικυρωτής JSON σχετίζονται, αλλά δεν επιλύουν το ίδιο πρόβλημα. Η μορφοποίηση κάνει το JSON πιο ευανάγνωστο. Η επικύρωση ελέγχει εάν το JSON μπορεί να αναλυθεί. Προτού επικολλήσετε ένα απόσπασμα σε έγγραφα, ένα πεδίο διαμόρφωσης, ένα πρόβλημα ή μια απάντηση υποστήριξης, μπορεί να χρειαστείτε ένα ή και τα δύο.
Ο JSON / YAML / TOML Converter της Converty διατηρεί αυτές τις εργασίες μαζί: επικυρώστε την είσοδο, μορφοποιήστε την για έλεγχο, ελαχιστοποιήστε την όταν έχει σημασία η συμπαγής έξοδος και μετατρέψτε την όταν το επόμενο σύστημα αναμένει YAML ή TOML.
Χρησιμοποιήστε έναν μορφοποιητή όταν το JSON είναι δύσκολο να διαβαστεί
Η μορφοποίηση αφορά την παρουσίαση. Προσθέτει εσοχές και σπασίματα γραμμής, ώστε η δομή να είναι πιο εύκολο να επιθεωρηθεί.
Χρησιμοποιήστε τη μορφοποίηση όταν:
- ένα ωφέλιμο φορτίο ελαχιστοποιείται σε μία γραμμή
- τα ένθετα αντικείμενα είναι δύσκολο να ακολουθηθούν
- Ένα παράδειγμα API πρέπει να εμφανίζεται στην τεκμηρίωση
- Οι αναθεωρητές πρέπει να συγκρίνουν γρήγορα τα πεδία
- μια απάντηση υποστήριξης χρειάζεται ένα ευανάγνωστο απόσπασμα
Η μορφοποίηση δεν αποδεικνύει ότι το παράδειγμα είναι σημασιολογικά σωστό. Απλώς κάνει τη δομή ορατή.
Χρησιμοποιήστε ένα εργαλείο επικύρωσης όταν το JSON ενδέχεται να μην είναι έγκυρο
Η επικύρωση αφορά τη δυνατότητα ανάλυσης. Εντοπίζει προβλήματα σύνταξης όπως λείπουν κόμματα, μη κλειστές συμβολοσειρές, μη έγκυρα εισαγωγικά ή σπασμένη ένθεση.
Χρησιμοποιήστε επικύρωση προτού επικολλήσετε το JSON σε ένα σύστημα που θα απορρίψει τη μη έγκυρη εισαγωγή. Είναι επίσης χρήσιμο πριν από την κοινή χρήση παραδειγμάτων, επειδή τα μη έγκυρα αποσπάσματα χάνουν τον χρόνο του αναθεωρητή και καθιστούν την τεκμηρίωση λιγότερο αξιόπιστη.
Χρησιμοποιήστε και τα δύο πριν μοιραστείτε σημαντικά παραδείγματα
Η ασφαλέστερη ροή εργασίας είναι πρώτα η επικύρωση και μετά η μορφοποίηση. Εάν το JSON δεν αναλύει, διορθώστε το πριν ανησυχείτε για την παρουσίαση. Μόλις είναι έγκυρο, μορφοποιήστε το έτσι ώστε οι άνθρωποι να μπορούν να το διαβάσουν.
Αυτή η ακολουθία είναι ιδιαίτερα χρήσιμη για παραδείγματα API. Για μια εστιασμένη ροή εργασίας κοινής χρήσης API, διαβάστε το Πώς να μορφοποιήσετε το JSON Πριν από την κοινή χρήση ενός παραδείγματος API.
Όταν η μετατροπή εισέρχεται στην εικόνα
Μερικές φορές το επόμενο σύστημα χρειάζεται YAML ή TOML αντί για JSON. Η μετατροπή είναι μια τρίτη εργασία, ξεχωριστή από τη μορφοποίηση και την επικύρωση. Αλλάζει τη σύνταξη ενώ προσπαθεί να διατηρήσει τη δομή των δεδομένων.
Δεν αντιστοιχίζεται καθαρά κάθε δομή σε κάθε μορφή, γι' αυτό έχουν σημασία οι προειδοποιήσεις συμβατότητας. Εάν η έξοδος TOML δεν είναι διαθέσιμη, διαβάστε το Γιατί η έξοδος TOML δεν είναι διαθέσιμη για ορισμένες εισόδους JSON ή YAML.
Ανοίξτε το JSON / YAML / TOML Converter όταν χρειάζεται να επικυρώσετε, να μορφοποιήσετε, να ελαχιστοποιήσετε ή να μετατρέψετε δομημένα δεδομένα πριν τα επικολλήσετε στην επόμενη ροή εργασίας.
