OpenAPI TypeScript-iks
Loo YAML- või JSON-vormingus OpenAPI 3 või Swagger 2.0 dokumendi skeemide põhjal TypeScript tüübid. Iga components.schemas all olev kirje või Swagger 2.0 puhul definitions muutub eksporditud liideseks või tüübi aliaseks. Nendevahelistest $ref-viidetest saavad tüübinimed ning nullitavatele väljadele lisatakse | null.
Korduma kippuvad küsimused
Millised dokumendi osad teisendatakse?
OpenAPI 3 puhul teisendatakse jaotises components.schemas ja Swagger 2.0 puhul jaotises definitions olevad skeemid. Teid, parameetreid ega vastuseid tüüpideks ei teisendata; kasuta loodud skeemitüüpe oma päringu- ja vastusekoodis.
Kuidas skeemide nimed tüübivaldisteks teisendatakse?
Iga skeemivõtme nimi teisendatakse PascalCase’i, näiteks user-profile muutub nimeks UserProfile. Kui kaks võtit annaksid sama nime, lisatakse teisele number.
Kas nullitavaid välju toetatakse?
Jah. OpenAPI 3.0 nullable: true ja Swagger 2.0 x-nullable: true lisavad tüübile | null ning OpenAPI 3.1 tüübi massiivid, näiteks ["string", "null"], muutuvad kujuks string | null.
Mis juhtub viidetega, mida tööriist ei suuda lahendada?
$ref, mis viitab dokumendivälisele elemendile või mille siht pole jaotises components.schemas või definitions olev skeem, muutub unknown-tüübiks ja loetletakse väljundi alguses kommentaaris.
Kas YAML on toetatud?
Jah. Kleebi dokument kujul YAML või JSON. YAML ankrud ja aliased laiendatakse enne teisendamist.
Kuidas dokumenti esmalt kontrollida?
Kasuta OpenAPI validaatorit, mis loetleb struktuuriprobleemid ja katkised viited. See teisendi loeb ainult skeeme ega teata muudest vigadest.