Μετάβαση στο περιεχόμενο

Δημιουργία σχήματος JSON

Δημιουργήστε ένα σχήμα JSON από δείγμα JSON. Η γεννήτρια συμπεραίνει τύπους, υποχρεωτικές ιδιότητες, σχήματα στοιχείων πίνακα και συνήθεις μορφές συμβολοσειρών, όπως date-time, email, uri και uuid, και δημιουργεί ένα σχήμα για draft 2020-12, 2019-09 ή draft-07, το οποίο μπορείτε να χρησιμοποιήσετε για την επικύρωση αιτημάτων, την τεκμηρίωση ενός API ή τη δημιουργία φορμών.

Επαναφορά

Συχνές ερωτήσεις

Ποια draft του σχήματος JSON υποστηρίζονται;

Το draft 2020-12, η τρέχουσα έκδοση που χρησιμοποιεί το OpenAPI 3.1, το draft 2019-09 και το draft-07, που εξακολουθούν να αναμένουν πολλοί παλαιότεροι επικυρωτές και εργαλεία. Η επιλογή ορίζει το $schema URL· οι λέξεις-κλειδιά που δημιουργεί η γεννήτρια έχουν την ίδια σημασία και στα τρία.

Πώς καθορίζονται οι υποχρεωτικές ιδιότητες;

Μια ιδιότητα καταχωρίζεται στις υποχρεωτικές όταν εμφανίζεται σε κάθε δείγμα αυτού του αντικειμένου. Σε έναν πίνακα αντικειμένων, ένα κλειδί που λείπει από ορισμένα στοιχεία παραλείπεται από τις υποχρεωτικές. Απενεργοποιήστε την επιλογή για να δημιουργήσετε σχήμα χωρίς λίστες υποχρεωτικών ιδιοτήτων.

Ποιες μορφές συμβολοσειρών αναγνωρίζονται;

date-time, date, time, email, uri, uuid και ipv4. Μια μορφή προστίθεται μόνο όταν κάθε δείγμα της τιμής αυτής της ιδιότητας ταιριάζει σε αυτήν, επομένως μια τιμή ελεύθερου κειμένου διατηρεί την ιδιότητα ως απλή συμβολοσειρά. Απενεργοποιήστε την αναγνώριση αν δεν θέλετε λέξεις-κλειδιά μορφής.

Διακρίνει το σχήμα τους ακέραιους από τους δεκαδικούς;

Ναι. Μια ιδιότητα της οποίας τα δείγματα είναι όλα ακέραιοι λαμβάνει τον τύπο integer. Μόλις ένα δείγμα έχει δεκαδικό μέρος, ο τύπος γίνεται number, ο οποίος δέχεται και ακέραιους.

Πώς περιγράφονται οι πίνακες;

Ένας πίνακας λαμβάνει τον τύπο array και ένα σχήμα items που δημιουργείται από όλα τα στοιχεία του μαζί. Τα αντικείμενα σε έναν πίνακα συγχωνεύονται, οπότε το σχήμα items περιλαμβάνει κάθε κλειδί που εμφανίζεται σε οποιοδήποτε στοιχείο, ενώ στις υποχρεωτικές ιδιότητες περιλαμβάνονται μόνο τα κλειδιά που υπάρχουν σε όλα.

Τι συμβαίνει με τους μικτούς τύπους;

Όταν μια ιδιότητα περιέχει απλές τιμές διαφορετικών τύπων, όπως συμβολοσειρά σε ένα στοιχείο και null σε άλλο, το σχήμα τις καταγράφει ως πίνακα τύπων, για παράδειγμα ["string", "null"]. Όταν αντικείμενα ή πίνακες αναμειγνύονται με άλλους τύπους, η γεννήτρια χρησιμοποιεί anyOf με ένα σχήμα για κάθε τύπο.

Προσθέτει additionalProperties ή περιορισμούς;

Όχι. Ένα δείγμα δεν μπορεί να δείξει ποια επιπλέον κλειδιά απαγορεύονται ή ποια είναι τα πραγματικά ελάχιστα και μέγιστα όρια, επομένως η γεννήτρια παραλείπει τα additionalProperties, minLength, maximum και παρόμοιες λέξεις-κλειδιά. Προσθέστε τα χειροκίνητα όπου το απαιτούν τα δεδομένα σας.

Μπορώ να επικυρώσω δεδομένα με το αποτέλεσμα;

Ναι. Επικολλήστε το σχήμα και τα δεδομένα σας στο JSON Schema Validator ή χρησιμοποιήστε το με μια βιβλιοθήκη όπως το Ajv. Ελέγξτε πρώτα το σχήμα: αποτυπώνει το δείγμα σας, επομένως χρειάζεται μια μικρή τροποποίηση αν στα πραγματικά δεδομένα ένα πεδίο μπορεί να λείπει ή να έχει τιμή null, αλλά δεν ισχύει κάτι τέτοιο στο δείγμα.

Μπορώ να χρησιμοποιήσω το σχήμα στο OpenAPI;

Το OpenAPI 3.1 χρησιμοποιεί απευθείας το JSON Schema 2020-12, οπότε το παραγόμενο σχήμα μπορεί να τοποθετηθεί στο components/schemas αφού αφαιρέσετε τη γραμμή $schema. Το OpenAPI 3.0 χρησιμοποιεί ένα παλαιότερο υποσύνολο· εκεί, αντικαταστήστε τους πίνακες type με nullable.

Πόσο μεγάλο μπορεί να είναι το αρχείο εισόδου;

Έως 1,000,000 χαρακτήρες JSON, με ένθεση έως 64 επιπέδων. Το δείγμα αναλύεται μόνο για αυτό το αίτημα και δεν αποθηκεύεται.

Σχετικά με το OneClick Pro

Το OneClick Pro είναι μια δωρεάν συλλογή με περισσότερα από 150 διαδικτυακά εργαλεία για καθημερινή εργασία: μετατροπή εικόνων και μονάδων, μορφοποίηση και επικύρωση κώδικα, έλεγχος τομέων και SEO, καθώς και εργασία με κείμενο, ημερομηνίες και αριθμούς. Κάθε εργαλείο λειτουργεί χωρίς εγγραφή ή συνδρομή, και ό,τι εισάγετε χρησιμοποιείται μόνο για τον υπολογισμό του αποτελέσματός σας και δεν αποθηκεύεται ποτέ. Χρησιμοποιήστε το ως γρήγορη εργαλειοθήκη για μεμονωμένες εργασίες ή αποθηκεύστε στα αγαπημένα τα εργαλεία που χρησιμοποιείτε καθημερινά.