OpenAPI átalakítása TypeScript-vé
Készítsen TypeScript-típusokat egy OpenAPI 3 vagy Swagger 2.0 dokumentum sémáiból, YAML vagy JSON formátumban. A components.schemas alatti minden elem, illetve a Swagger 2.0 definíciói exportált interfésszé vagy típusaliasszá válnak; az $ref közötti hivatkozások típusnevekre mutatnak, a null értékű mezők pedig | null értéket kapnak.
Gyakran ismételt kérdések
A dokumentum mely részei alakulnak át?
Az OpenAPI 3 esetében a components.schemas alatti sémák, a Swagger 2.0 esetében pedig a definitions alattiak. Az útvonalakból, paraméterekből és válaszokból nem lesznek típusok; a generált sématípusokra a saját kérés- és válaszkódjában hivatkozhat.
Hogyan alakulnak a sémanevek típusnevekké?
Minden sémakulcs PascalCase formátumú névvé alakul, így a user-profile névből UserProfile lesz. Ha két kulcsból ugyanaz a név adódna, a második végére szám kerül.
Támogatottak a null értékű mezők?
Igen. Az OpenAPI 3.0 nullable: true és a Swagger 2.0 x-nullable: true értéke | null elemet ad hozzá; az OpenAPI 3.1 olyan típusérték-tömbjei pedig, mint a ["string", "null"], string | null formátumúvá válnak.
Mi történik az eszköz által fel nem oldható hivatkozásokkal?
A $ref hivatkozás, amely a dokumentumon kívülre vagy a components.schemas illetve definitions alatti sémától eltérő elemre mutat, unknown típusúvá válik, és a kimenet tetején lévő megjegyzésben jelenik meg.
Támogatott a YAML?
Igen. Illessze be a dokumentumot YAML vagy JSON formátumban. A YAML horgonyokat és aliasokat az átalakítás előtt kibontja.
Hogyan ellenőrizhetem előbb a dokumentumot?
Használja az OpenAPI-érvényesítőt, amely felsorolja a szerkezeti problémákat és a hibás hivatkozásokat. Ez az átalakító csak a sémákat olvassa be, más hibákat nem jelez.