Επικύρωση JSON Schema
Επικυρώστε JSON με βάση ένα JSON Schema και δείτε κάθε σφάλμα μαζί με τη διαδρομή της τιμής που δεν περνά τον έλεγχο και τον κανόνα που παραβιάζει, συμπεριλαμβανομένων μορφών όπως email και date-time. Εκτελείται στο πρόγραμμα περιήγησής σας.
Είσοδος
Έξοδος
Readme
Τι είναι ένα σχήμα JSON;
Ένα σχήμα JSON περιγράφει πώς πρέπει να είναι ένα έγγραφο JSON: ποιες ιδιότητες έχει ένα αντικείμενο, ποιες από αυτές είναι υποχρεωτικές, τον τύπο κάθε τιμής, τα επιτρεπόμενα εύρη και μήκη, καθώς και μοτίβα και μορφές, όπως διευθύνσεις email ή ημερομηνίες. Τα API, τα αρχεία διαμόρφωσης και τα εργαλεία δημιουργίας φορμών χρησιμοποιούν σχήματα για να ελέγχουν τα δεδομένα προτού τα εμπιστευτούν, ενώ το OpenAPI τα χρησιμοποιεί για να περιγράφει τα σώματα αιτημάτων και αποκρίσεων.
Πώς να χρησιμοποιήσετε τον επικυρωτή
- Επικολλήστε ή πληκτρολογήστε το σχήμα JSON στο πρώτο πλαίσιο.
- Επικολλήστε ή πληκτρολογήστε τα δεδομένα JSON που θέλετε να ελέγξετε στο δεύτερο πλαίσιο.
- Το αποτέλεσμα εμφανίζεται καθώς πληκτρολογείτε: είτε το JSON είναι έγκυρο είτε παρατίθενται όλα τα σφάλματα, μαζί με τη διαδρομή της τιμής που αποτυγχάνει, τη λέξη-κλειδί του σχήματος που παραβιάζει και μια σύντομη επεξήγηση.
- Κάθε τιμή που αποτυγχάνει επισημαίνεται στα δεδομένα. Κάντε κλικ σε ένα σφάλμα για να μετακινηθείτε στα αντίστοιχα δεδομένα ή κάντε κλικ σε μια επισήμανση για να εντοπίσετε το σφάλμα στη λίστα.
Το πεδίο «Έκδοση σχήματος» δείχνει με ποια έκδοση του JSON Schema ελέγχθηκαν τα δεδομένα.
Ποιες εκδόσεις υποστηρίζει
Η λέξη-κλειδί $schema του σχήματος καθορίζει την έκδοση:
- Έκδοση 2020-12:
https://json-schema.org/draft/2020-12/schema - Έκδοση 2019-09:
https://json-schema.org/draft/2019-09/schema - Έκδοση 7:
http://json-schema.org/draft-07/schema# - Έκδοση 6:
http://json-schema.org/draft-06/schema#
Ένα σχήμα χωρίς $schema ελέγχεται ως έκδοση 7. Οι εκδόσεις 4 και παλαιότερες δεν υποστηρίζονται. Αρχικά, το ίδιο το σχήμα ελέγχεται με βάση το μετα-σχήμα της έκδοσής του, επομένως ένα τυπογραφικό λάθος όπως "type": "strin" αναφέρεται ως μη έγκυρο σχήμα και δεν αγνοείται. Σχόλια όπως τα title, description και examples είναι αποδεκτά, όπως και λέξεις-κλειδιά που δεν αναγνωρίζει η έκδοση, για παράδειγμα δικές σας επισημάνσεις x-: αγνοούνται.
Ανάγνωση των σφαλμάτων
- Οι διαδρομές γράφονται ως JSONPath, με αφετηρία το
$, δηλαδή ολόκληρο το έγγραφο: το$.ingredients[1].unitείναι η ιδιότηταunitτου δεύτερου συστατικού. - Μια ιδιότητα που λείπει, ενώ είναι υποχρεωτική, αναφέρεται στο αντικείμενο που θα έπρεπε να την περιέχει, ενώ το μήνυμα περιλαμβάνει το όνομα της ιδιότητας.
- Μια επιπλέον ιδιότητα που δεν επιτρέπεται από το σχήμα επισημαίνεται με το όνομά της.
- Για τα
enumκαιconst, το μήνυμα παραθέτει τις επιτρεπόμενες τιμές. - Με τα
anyOfκαιoneOf, κάθε κλάδος που αποτυγχάνει προσθέτει τα δικά του σφάλματα, ενώ στη συνέχεια προστίθεται και ένα σφάλμα για την ίδια τη λέξη-κλειδί. Έτσι, μία λανθασμένη τιμή μπορεί να προκαλέσει πολλά σφάλματα.
Τα μηνύματα σφάλματος προέρχονται από τη βιβλιοθήκη Ajv και είναι στα Αγγλικά.
Μορφές
Ελέγχονται επίσης οι τιμές με format: email, uri, uri-reference, date, time, date-time, duration, uuid, ipv4, ipv6, hostname, regex, json-pointer και άλλες. Μια μορφή που δεν αναγνωρίζει ο επικυρωτής αγνοείται, όπως επιτρέπει η προδιαγραφή JSON Schema.
Αναφορές
Το $ref λειτουργεί για ορισμούς μέσα στο ίδιο σχήμα, όπως τα #/$defs/address ή #/definitions/address. Δεν γίνεται ανάκτηση αναφορών σε άλλα αρχεία ή URL: ένα σχήμα που χρειάζεται τέτοια αναφορά αναφέρεται ως μη έγκυρο, μαζί με την αναφορά που δεν ήταν δυνατό να επιλυθεί.
Πώς λειτουργεί
Το εργαλείο επικυρώνει με το Ajv, έναν ευρέως χρησιμοποιούμενο επικυρωτή JSON Schema, και ελέγχει τις μορφές με το ajv-formats. Όλα εκτελούνται στο πρόγραμμα περιήγησής σας: το σχήμα και τα δεδομένα δεν αποστέλλονται ποτέ.
Δυνατότητες
- Υποστήριξη των εκδόσεων 6, 7, 2019-09 και 2020-12 του JSON Schema, με επιλογή μέσω του
$schema - Εμφάνιση κάθε σφάλματος με τη διαδρομή, τη λέξη-κλειδί και το μήνυμά του
- Επισήμανση των τιμών που αποτυγχάνουν στα δεδομένα, με δυνατότητα μετάβασης σε αυτές με κλικ
- Έλεγχοι μορφής για email, URI, ημερομηνίες, UUID, διευθύνσεις IP και άλλα
- Έλεγχος του σχήματος με βάση το μετα-σχήμα του
- Γραμμή και στήλη των σφαλμάτων σύνταξης JSON
- Εκτέλεση στο πρόγραμμα περιήγησής σας