OpenAPI → TypeScript
Luo TypeScript-tyyppejä OpenAPI 3- tai Swagger 2.0 -dokumentin skeemoista muodossa YAML tai JSON. Jokaisesta components.schemas-kohdan alkiosta tai Swagger 2.0:n definitions-kohdasta tulee viety rajapinta tai tyyppialias. $ref-viittaukset toisiinsa muuttuvat tyyppinimiksi, ja null-arvoiset kentät saavat tyypin | null.
Usein kysytyt kysymykset
Mitkä dokumentin osat muunnetaan?
OpenAPI 3:n components.schemas-kohdan skeemat ja Swagger 2.0:n definitions-kohdan skeemat. Polkuja, parametreja ja vastauksia ei muunnetta tyypeiksi; viittaa luotuihin skeematyyppeihin omassa pyyntö- ja vastauskoodissasi.
Miten skeemojen nimet muunnetaan tyyppinimiksi?
Kunkin skeeman avain muunnetaan PascalCase-muotoon, joten user-profile muuttuu muotoon UserProfile. Jos kahdesta avaimesta tulisi sama nimi, jälkimmäisen perään lisätään numero.
Tuetaanko null-arvoja sallivia kenttiä?
Kyllä. OpenAPI 3.0:n nullable: true ja Swagger 2.0:n x-nullable: true lisäävät tyyppiin | null. OpenAPI 3.1:n tyyppitaulukoista, kuten ["string", "null"], tulee string | null.
Mitä tapahtuu viittauksille, joita työkalu ei voi ratkaista?
Dokumentin ulkopuolelle tai muualle kuin components.schemas-kohdan tai definitions-kohdan skeemaan osoittavasta $ref-viittauksesta tulee unknown, ja se luetellaan tulosteen alussa olevassa kommentissa.
Tuetaanko YAML-muotoa?
Kyllä. Liitä dokumentti muodossa YAML tai JSON. Kohdan YAML ankkurit ja aliakset laajennetaan ennen muunnosta.
Miten tarkistan dokumentin ensin?
Käytä OpenAPI-validaattoria, joka luettelee rakenteelliset ongelmat ja rikkinäiset viittaukset. Tämä muunnin lukee vain skeemat eikä ilmoita muista virheistä.