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

OpenAPI σε TypeScript

Δημιουργήστε τύπους TypeScript από τα σχήματα ενός εγγράφου OpenAPI 3 ή Swagger 2.0 σε YAML ή JSON. Κάθε καταχώριση στο components.schemas ή στα definitions του Swagger 2.0 γίνεται εξαγόμενη διεπαφή ή ψευδώνυμο τύπου. Οι σύνδεσμοι $ref μεταξύ τους γίνονται ονόματα τύπων και στα nullable πεδία προστίθεται | null.

Επαναφορά

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

Ποια μέρη του εγγράφου μετατρέπονται;

Τα σχήματα στο components.schemas του OpenAPI 3 και στα definitions του Swagger 2.0. Οι διαδρομές, οι παράμετροι και οι αποκρίσεις δεν μετατρέπονται σε τύπους· ανατρέξτε στους τύπους των σχημάτων που δημιουργήθηκαν από τον δικό σας κώδικα αιτημάτων και αποκρίσεων.

Πώς μετατρέπονται τα ονόματα σχημάτων σε ονόματα τύπων;

Κάθε κλειδί σχήματος αναδιαμορφώνεται σε PascalCase, επομένως το user-profile γίνεται UserProfile. Όταν δύο κλειδιά θα έδιναν το ίδιο όνομα, στο δεύτερο προστίθεται ένας αριθμός.

Υποστηρίζονται nullable πεδία;

Ναι. Τα nullable: true του OpenAPI 3.0 και x-nullable: true του Swagger 2.0 προσθέτουν | null, ενώ οι πίνακες τύπων του OpenAPI 3.1, όπως ["string", "null"], γίνονται string | null.

Τι συμβαίνει με αναφορές που δεν μπορεί να επιλύσει το εργαλείο;

Ένα $ref που παραπέμπει εκτός του εγγράφου ή σε κάτι διαφορετικό από ένα σχήμα στο components.schemas ή στα definitions γίνεται unknown και καταγράφεται σε σχόλιο στην αρχή του αποτελέσματος.

Υποστηρίζεται το YAML;

Ναι. Επικολλήστε το έγγραφο ως YAML ή JSON. Τα anchors και τα aliases στο YAML αναπτύσσονται πριν από τη μετατροπή.

Πώς μπορώ να ελέγξω πρώτα το έγγραφο;

Χρησιμοποιήστε τον Επικυρωτή OpenAPI, ο οποίος παραθέτει δομικά προβλήματα και κατεστραμμένες αναφορές. Αυτός ο μετατροπέας διαβάζει μόνο τα σχήματα και δεν αναφέρει άλλα σφάλματα.

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

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