Preskoči na vsebino

Shema JSON v TypeScript

Pretvorite shemo JSON v tipe TypeScript. Objekti postanejo vmesniki z obveznimi in neobveznimi lastnostmi; $defs in definicije postanejo poimenovani izvozi, na katere kaže $ref; enum in const postaneta literalna tipa, anyOf in oneOf postaneta uniji, allOf pa presek. Opisi se ohranijo kot komentarji dokumentacije.

Ponastavi

Pogosta vprašanja

Kateri osnutki shem JSON so podprti?

Pretvornik bere ključne besede, skupne osnutku draft-07, 2019-09 in 2020-12: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf ter $ref v $defs ali definitions. Ključne besede za preverjanje, kot sta minLength ali pattern, nimajo ustreznice v TypeScript in so izpuščene.

Kako se razrešijo sklici $ref?

Sklici na #, #/$defs/Name in #/definitions/Name postanejo poimenovani tip ustrezne definicije. Vsak drug sklic, na primer na drugo datoteko ali URL, dobi tip unknown in je naveden v komentarju na vrhu izhoda.

Kako se obravnava additionalProperties?

Objekt brez lastnosti in s shemo additionalProperties postane Record<string, T>. Objekt z lastnostmi in shemo additionalProperties postane vmesnik, združen z Record<string, T>. Vrednost additionalProperties false ali manjkajoča ključna beseda ne doda ničesar, ker objektni tipi TypeScript že opisujejo znane ključe.

Kaj naredi nullable?

Ključna beseda OpenAPI 3.0 nullable: true in razširitev Swagger x-nullable dodata tipu | null. V sami shemi JSON zapišite type: ["string", "null"], kar postane string | null.

Ali so podprte rekurzivne sheme?

Da. Definicija, ki se prek $ref sklicuje sama nase ali na drugo definicijo, postane poimenovani tip, ki se sklicuje na drugo ime; TypeScript to brez težav razreši.

Ali preveri, ali je moja shema veljavna?

Prebere samo shemo. Neznane ključne besede prezre, shema brez tipa pa postane unknown. Za preverjanje podatkov glede na shemo uporabite validator shem JSON.

O spletnem mestu OneClick Pro

OneClick Pro je brezplačna zbirka z več kot 150 spletnimi orodji za vsakodnevno delo: za pretvarjanje slik in enot, oblikovanje in preverjanje kode, preverjanje domen in SEO ter delo z besedilom, datumi in števili. Vsako orodje deluje brez registracije ali naročnine, vnesene podatke pa uporabimo samo za izračun rezultata in jih nikoli ne shranimo. Zbirko lahko uporabljate kot priročen nabor orodij za posamezna opravila ali si dodate med zaznamke orodja, ki jih uporabljate vsak dan.