JSON-skeema → TypeScript
Muunna JSON-skeema TypeScript-tyypeiksi. Objekteista tulee rajapintoja, joissa on pakollisia ja valinnaisia ominaisuuksia. $defs ja definitions muuttuvat nimetyiksi vienneiksi, joihin $ref viittaa. Enum ja const muuttuvat literaalityypeiksi, anyOf ja oneOf unioneiksi sekä allOf leikkaukseksi. Kuvaukset säilytetään dokumentaatiokommentteina.
Usein kysytyt kysymykset
Mitä JSON-skeemaversioita tuetaan?
Muunntimessa käsitellään avainsanat, jotka ovat yhteisiä luonnoksille draft-07, 2019-09 ja 2020-12: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf sekä $ref, joka voi olla $defs tai definitions. Validointiavainsanoilla, kuten minLength ja pattern, ei ole TypeScript-vastaavuutta, joten ne jätetään pois.
Miten $ref-viittaukset ratkaistaan?
Viittauksista #, #/$defs/Name ja #/definitions/Name tulee kyseisen määritelmän nimetty tyyppi. Muista viittauksista, esimerkiksi toiseen tiedostoon tai URL-kohteeseen, tulee unknown-tyyppi, ja ne luetellaan tulosteen alussa olevassa kommentissa.
Miten additionalProperties käsitellään?
Objektista, jolla ei ole ominaisuuksia mutta jolla on additionalProperties-skeema, tulee Record<string, T>. Objektista, jolla on ominaisuuksia ja additionalProperties-skeema, tulee rajapinta, johon yhdistetään Record<string, T>. Arvo false tai puuttuva avainsana ei lisää mitään, sillä TypeScript-objektityypit kuvaavat jo tunnetut avaimet.
Mitä nullable tekee?
OpenAPI 3.0:n nullable: true -avainsana ja Swaggerin x-nullable-laajennus lisäävät tyyppiin | null. JSON-skeemassa kirjoita itse type: ["string", "null"], josta tulee string | null.
Tuetaanko rekursiivisia skeemoja?
Kyllä. Määritelmästä, joka viittaa itseensä tai toiseen määritelmään $ref-viittauksen kautta, tulee nimetty tyyppi, joka viittaa toiseen nimeen. TypeScript ratkaisee sen ongelmitta.
Tarkistaako työkalu, että skeemani on kelvollinen?
Työkalu lukee vain skeeman. Tuntemattomat avainsanat ohitetaan, ja skeemasta, jossa ei ole type-arvoa, tulee unknown. Tarkista tiedot skeemaa vasten JSON-skeeman validaattorilla.