JSON séma átalakítása TypeScript-típusokká
Alakítson át egy JSON sémát TypeScript-típusokká. Az objektumok interfészekké válnak kötelező és opcionális tulajdonságokkal; az $defs és a definíciók névvel exportált elemekké válnak, amelyekre a $ref hivatkozik. Az enum és const literáltípusokká alakul, az anyOf és oneOf uniót, az allOf pedig metszetet alkot. A leírások dokumentációs megjegyzésként megmaradnak.
Gyakran ismételt kérdések
Mely JSON séma-változatokat támogatja?
Az átalakító a draft-07, a 2019-09 és a 2020-12 által közösen használt kulcsszavakat olvassa be: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf, valamint a $ref értéket a $defs vagy a definitions elemhez. Az olyan érvényesítési kulcsszavaknak, mint a minLength vagy a pattern, nincs TypeScript megfelelőjük, ezért kimaradnak.
Hogyan oldódnak fel a $ref hivatkozások?
A #, #/$defs/Name és #/definitions/Name hivatkozások a megfelelő definíció névvel ellátott típusává válnak. Minden más hivatkozás, például egy másik fájlra vagy egy URL-re mutató hivatkozás, unknown típust kap, és a kimenet tetején lévő megjegyzésben jelenik meg.
Hogyan kezeli az additionalProperties kulcsszót?
A tulajdonság nélküli, de additionalProperties sémát tartalmazó objektum Record<string, T> típussá válik. A tulajdonságokat és additionalProperties sémát egyaránt tartalmazó objektumnál az interfész Record<string, T> típussal egészül ki. A false értékű additionalProperties vagy a hiányzó kulcsszó nem ad hozzá semmit, mert a TypeScript objektumtípusok már leírják az ismert kulcsokat.
Mit csinál a nullable?
Az OpenAPI 3.0 nullable: true kulcsszava és a Swagger x-nullable kiterjesztése | null értéket ad a típushoz. Magában a JSON sémában írja be a type: ["string", "null"] értéket; ebből string | null lesz.
Támogatottak a rekurzív sémák?
Igen. Az a definíció, amely önmagára vagy egy másik definícióra hivatkozik a $ref használatával, névvel ellátott típussá válik, amely a másik névre hivatkozik; ezt a TypeScript probléma nélkül feloldja.
Ellenőrzi az eszköz, hogy érvényes-e a sémám?
Csak beolvassa a sémát. Az ismeretlen kulcsszavakat figyelmen kívül hagyja, a típus nélküli sémából pedig unknown lesz. Az adatok séma szerinti ellenőrzéséhez használja a JSON Schema Validator eszközt.