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

Σχήμα JSON σε TypeScript

Μετατρέψτε ένα σχήμα JSON σε τύπους TypeScript. Τα αντικείμενα γίνονται διεπαφές με υποχρεωτικές και προαιρετικές ιδιότητες, τα $defs και οι ορισμοί γίνονται επώνυμες εξαγωγές στις οποίες παραπέμπει το $ref, τα enum και const γίνονται κυριολεκτικοί τύποι, τα anyOf και oneOf γίνονται ενώσεις και το allOf γίνεται τομή. Οι περιγραφές διατηρούνται ως σχόλια τεκμηρίωσης.

Επαναφορά

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

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

Ο μετατροπέας διαβάζει τις κοινές λέξεις-κλειδιά των draft-07, 2019-09 και 2020-12: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf και $ref σε $defs ή definitions. Οι λέξεις-κλειδιά επικύρωσης, όπως οι minLength και pattern, δεν έχουν αντίστοιχο στο TypeScript και παραλείπονται.

Πώς επιλύονται οι αναφορές $ref;

Οι αναφορές σε #, #/$defs/Name και #/definitions/Name γίνονται ονομαστικοί τύποι για τον αντίστοιχο ορισμό. Κάθε άλλη αναφορά, όπως μία σε άλλο αρχείο ή σε ένα URL, ορίζεται ως unknown και καταγράφεται σε σχόλιο στην αρχή του αποτελέσματος.

Πώς αντιμετωπίζεται το additionalProperties;

Ένα αντικείμενο χωρίς ιδιότητες και με σχήμα additionalProperties γίνεται Record<string, T>. Ένα αντικείμενο με ιδιότητες και σχήμα additionalProperties γίνεται η διεπαφή ενωμένη με Record<string, T>. Το additionalProperties false ή η απουσία αυτής της λέξης-κλειδιού δεν προσθέτει κάτι, επειδή οι τύποι αντικειμένων TypeScript περιγράφουν ήδη τα γνωστά κλειδιά.

Τι κάνει το nullable;

Η λέξη-κλειδί nullable: true του OpenAPI 3.0 και η επέκταση x-nullable του Swagger προσθέτουν | null στον τύπο. Στο ίδιο το σχήμα JSON, γράψτε type: ["string", "null"], που γίνεται string | null.

Υποστηρίζονται αναδρομικά σχήματα;

Ναι. Ένας ορισμός που παραπέμπει στον εαυτό του ή σε άλλον ορισμό μέσω του $ref γίνεται ονομαστικός τύπος που παραπέμπει στο άλλο όνομα και τον οποίο το TypeScript επιλύει χωρίς πρόβλημα.

Ελέγχει αν το σχήμα μου είναι έγκυρο;

Διαβάζει μόνο το σχήμα. Οι άγνωστες λέξεις-κλειδιά αγνοούνται και ένα σχήμα χωρίς type γίνεται unknown. Χρησιμοποιήστε τον επικυρωτή σχήματος JSON για να ελέγξετε δεδομένα βάσει ενός σχήματος.

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

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