JSON σε TypeScript
Μετατρέψτε ένα δείγμα JSON σε TypeScript interfaces ή type aliases. Τα ένθετα αντικείμενα γίνονται ξεχωριστοί επώνυμοι τύποι, οι πίνακες αντικειμένων συγχωνεύονται ώστε τα κλειδιά που λείπουν από ορισμένα στοιχεία να γίνονται προαιρετικά και οι μικτές τιμές γίνονται τύποι ένωσης. Επικολλήστε μια απόκριση API, επιλέξτε interface ή type και αντιγράψτε δηλώσεις που μπορείτε να προσθέσετε απευθείας στον κώδικά σας.
Συχνές ερωτήσεις
Πώς διαχειρίζεται τα ένθετα αντικείμενα;
Κάθε ένθετο αντικείμενο αποκτά τη δική του δήλωση, με όνομα που προκύπτει από το κλειδί που το περιέχει σε PascalCase, για παράδειγμα το address γίνεται Address. Τα αντικείμενα μέσα σε πίνακες ονομάζονται από τον ενικό του κλειδιού του πίνακα, οπότε το users γίνεται User και το categories γίνεται Category. Αντικείμενα με ακριβώς τα ίδια πεδία μοιράζονται την ίδια δήλωση.
Πότε γίνεται μια ιδιότητα προαιρετική;
Όταν ένας πίνακας περιέχει πολλά αντικείμενα και κάποιο κλειδί λείπει από ορισμένα από αυτά, το κλειδί σημειώνεται ως προαιρετικό με ένα ερωτηματικό. Τα κλειδιά που εμφανίζονται σε κάθε στοιχείο παραμένουν υποχρεωτικά. Ένα μεμονωμένο αντικείμενο δεν έχει άλλα δείγματα για σύγκριση, επομένως όλα τα κλειδιά του είναι υποχρεωτικά.
Πώς τυποποιούνται οι τιμές null;
Ένα κλειδί που έχει τιμή null στο δείγμα σας τυποποιείται ως null, ενώ ένα κλειδί που έχει τιμή null σε ορισμένα στοιχεία και συμβολοσειρά σε άλλα γίνεται string | null. Αν ένα πεδίο μπορεί να έχει τιμή null στα πραγματικά δεδομένα, αλλά δεν έχει ποτέ τέτοια τιμή στο δείγμα σας, προσθέστε το null χειροκίνητα ή επικολλήστε ένα δείγμα που το περιλαμβάνει.
Να επιλέξω interface ή type;
Και τα δύο περιγράφουν το ίδιο σχήμα. Τα interfaces μπορούν να επεκταθούν και να συγχωνευτούν, κάτι που προτιμούν πολλοί οδηγοί στυλ για σχήματα αντικειμένων· τα type aliases λειτουργούν επίσης για ενώσεις και είναι η επιλογή ορισμένων ομάδων για τα πάντα. Επιλέξτε ό,τι χρησιμοποιεί η βάση κώδικά σας· τα πεδία είναι ίδια.
Πώς τυποποιούνται οι πίνακες;
Ένας πίνακας με τιμές ενός είδους γίνεται αυτός ο τύπος με [] μετά από αυτόν, όπως string[] ή User[]. Ένας πίνακας με πολλά είδη γίνεται ένωση μέσα σε παρενθέσεις, όπως (string | number)[]. Ένας κενός πίνακας γίνεται unknown[], επειδή το δείγμα δεν παρέχει πληροφορίες για τα στοιχεία του.
Τι γίνεται με τα κλειδιά που δεν είναι έγκυρα αναγνωριστικά;
Τα κλειδιά με κενά, παύλες ή άλλους χαρακτήρες που δεν επιτρέπονται σε αναγνωριστικό TypeScript γράφονται μέσα σε εισαγωγικά, για παράδειγμα "first-name": string, κάτι που είναι έγκυρο TypeScript και αντιστοιχεί ακριβώς στο JSON.
Οι αριθμοί τυποποιούνται ως ακέραιοι ή δεκαδικοί;
Το TypeScript έχει έναν τύπο αριθμού, οπότε τόσο οι ακέραιοι όσο και οι δεκαδικοί γίνονται number. Αν χρειάζεται να γνωρίζετε ποιες τιμές είναι ακέραιες, το JSON Schema Generator διακρίνει τους τύπους integer και number.
Μπορώ να μετονομάσω τον βασικό τύπο;
Ναι. Εισαγάγετε ένα όνομα για τον βασικό τύπο, όπως ApiResponse. Μετατρέπεται σε PascalCase και οι ένθετοι τύποι διατηρούν τα ονόματα που προκύπτουν από τα κλειδιά τους. Όταν το ανώτατο επίπεδο του JSON σας είναι πίνακας ή μεμονωμένη τιμή, ο βασικός τύπος γίνεται type alias για αυτό.
Αναγνωρίζονται οι ημερομηνίες;
Όχι. Το JSON δεν έχει τύπο ημερομηνίας, επομένως μια ημερομηνία στο δείγμα σας είναι συμβολοσειρά και τυποποιείται ως string. Μετατρέψτε την σε Date στον κώδικά σας μετά την ανάλυση ή περιορίστε τον τύπο χειροκίνητα αν χρησιμοποιείτε τύπο template literal.
Πόσο μεγάλο μπορεί να είναι το JSON;
Έως 1,000,000 χαρακτήρες, με ένθεση έως 64 επίπεδα βάθους. Το δείγμα αναλύεται μόνο για την παραγωγή των τύπων και δεν αποθηκεύεται.