Τι κάνει η Γεννήτρια JSON Schema;

Δημιουργεί ένα JSON Schema για εσάς, με βάση ένα παράδειγμα των δεδομένων σας. Επικολλήστε ένα δείγμα, όπως μια απόκριση API, ένα αρχείο ρυθμίσεων ή μια εγγραφή από εξαγωγή βάσης δεδομένων, και θα λάβετε ένα σχήμα που περιγράφει τη δομή του: τον τύπο κάθε τιμής, τις ιδιότητες κάθε αντικειμένου, τη μορφή των στοιχείων κάθε πίνακα και τις ιδιότητες που είναι υποχρεωτικές. Είναι μια γρήγορη αφετηρία για την τεκμηρίωση API, τις προδιαγραφές OpenAPI, την επικύρωση φορμών ή τα συμβόλαια δεδομένων, τα οποία μπορείτε στη συνέχεια να βελτιώσετε χειροκίνητα.

Πώς να το χρησιμοποιήσετε

  1. Επικολλήστε ή πληκτρολογήστε δείγμα JSON στο πεδίο εισαγωγής.
  2. Επιλέξτε την έκδοση JSON Schema για τη γραμμή $schema: Draft 2020-12 ή Draft 7.
  3. Επιλέξτε αν οι ιδιότητες θα επισημαίνονται ως υποχρεωτικές.
  4. Αντιγράψτε το σχήμα ή κατεβάστε το ως schema.json.

Αν το δείγμα δεν είναι έγκυρο JSON, το εργαλείο εμφανίζει τη γραμμή και τη στήλη του προβλήματος και το επισημαίνει.

Πώς προκύπτει το σχήμα

  • Σε κάθε τιμή αποδίδεται ο τύπος JSON της: string, boolean, null, object, array και integer για ακέραιους αριθμούς ή number για δεκαδικούς αριθμούς. Ένας πίνακας με ακέραιους και δεκαδικούς αριθμούς λαμβάνει τον τύπο number, ο οποίος καλύπτει και τις δύο περιπτώσεις.
  • Για κάθε κλειδί των αντικειμένων προστίθεται μια καταχώριση properties, η οποία περιγράφεται με τον ίδιο τρόπο, σε όσο βάθος υπάρχει στο δείγμα.
  • Για τους πίνακες προστίθεται ένα σχήμα items που ταιριάζει σε όλα τα στοιχεία. Όταν τα στοιχεία είναι αντικείμενα, οι ιδιότητές τους συγχωνεύονται, ώστε μια λίστα εγγραφών να δίνει ένα σχήμα για μία εγγραφή.
  • Για τιμές μικτών τύπων περιλαμβάνονται όλοι οι τύποι σε μια λίστα, όπως ["string", "null"], ή χρησιμοποιείται το anyOf όταν αναμειγνύονται αντικείμενα και άλλες τιμές.
  • Για έναν κενό πίνακα δημιουργείται "type": "array" χωρίς items, αφού δεν υπάρχει κάτι προς περιγραφή.

Υποχρεωτικές ιδιότητες

Όταν είναι ενεργή η επιλογή «Επισήμανση ιδιοτήτων ως υποχρεωτικών», τα κλειδιά κάθε αντικειμένου καταγράφονται στη λίστα required. Για έναν πίνακα αντικειμένων, μια ιδιότητα είναι υποχρεωτική μόνο αν υπάρχει σε κάθε στοιχείο: σε μια λίστα μελών όπου μόνο ορισμένα έχουν την ιδιότητα favorite, αυτή η ιδιότητα είναι προαιρετική. Απενεργοποιήστε την επιλογή για να λάβετε ένα σχήμα χωρίς λίστες required.

Τι δεν μπορεί να αποκαλύψει ένα δείγμα

Ένα σχήμα που δημιουργείται από ένα μόνο παράδειγμα γνωρίζει μόνο όσα εμφανίζονται σε αυτό. Δεν μπορεί να γνωρίζει ποιες τιμές τύπου string είναι διευθύνσεις email ή ημερομηνίες, ποια είναι τα πιθανά όρια των αριθμών ή αν μια ιδιότητα που εμφανίζεται μία φορά μπορεί επίσης να λείπει. Προσθέστε χειροκίνητα τα format, minimum, maxLength, enum ή pattern όπου χρειάζεται και ελέγξτε τα δεδομένα σε σχέση με το αποτέλεσμα με τον Επικυρωτή JSON Schema.

Πώς λειτουργεί

Το εργαλείο χρησιμοποιεί το genson-js, μια μεταφορά του δημιουργού σχημάτων GenSON σε JavaScript. Οι λέξεις-κλειδιά που δημιουργεί έχουν την ίδια σημασία τόσο στο Draft 7 όσο και στο Draft 2020-12, επομένως η έκδοση αλλάζει μόνο τη γραμμή $schema. Όλα εκτελούνται στο πρόγραμμα περιήγησής σας: το δείγμα δεν μεταφορτώνεται ποτέ.

Δυνατότητες

  • Δημιουργία JSON Schema από οποιοδήποτε δείγμα JSON
  • Αυτόματος προσδιορισμός τύπων, ένθετων αντικειμένων και πινάκων
  • Συγχώνευση των στοιχείων πινάκων σε ένα σχήμα, με εντοπισμό προαιρετικών ιδιοτήτων
  • Draft 2020-12 ή Draft 7
  • Ενεργοποίηση ή απενεργοποίηση των υποχρεωτικών ιδιοτήτων
  • Αντιγραφή ή λήψη ως schema.json
  • Εκτέλεση στο πρόγραμμα περιήγησής σας