OpenAPI TypeScript típusok
OpenAPI vagy Swagger dokumentumot TypeScript interfészekké és típusokká konvertálj.
OpenAPI TypeScript típusok
Illeszd be az OpenAPI 3 vagy Swagger 2 dokumentumot — JSON vagy YAML formátumban — és ez az eszköz TypeScript interfészeket hoz létre az összes sémához a komponensek/sémák szakaszban, valamint egy típust minden végpont útjához, lekérdezési paramétereihez, kérés törzséhez és válaszaihoz. Megspórolja az API típusok kézi írásának lépéseit minden alkalommal, amikor a specifikáció változik, és szinkronban tartja a klienst azzal, amit a szerver valójában visszaad.
A lehetőségek szabályozzák a kimenet formáját. Válassz az interfész vagy típusdeklarációk között, és dönts arról, hogyan kerülnek beágyazásra a null értékeket tartalmazó mezők: opcionális tulajdonságként (x?: string) vagy null-lal való unióként (x: string | null). A $ref hivatkozások maradhatnak névvel rendelkező típusokként, amelyek az egyeztetett interfészre mutatnak, vagy beágyazódhatnak az eredménybe, ahol használatosak. Az "útvonal, paraméter és választípusok generálása" letiltásával csak az összetevő sémákat kapod meg, vagy kapcsold be az állapotkód uniót, hogy lásd az összes olyan válaszkódot, amelyet egy végpont vissza tud adni, egyetlen típusként. A specifikációból származó leírások JSDoc megjegyzésekké válnak az egyes mezők fölött, és egy névprefix megakadályozza az előállított típusok ütközését a sajátjaiddal, amikor beilleszted őket egy nagyobb kódba.
A parser beolvassa a szabványos OpenAPI konstrukciókat — objektum- és tömbsémákat, enumerációkat, oneOf/anyOf/allOf, nullable, additionalProperties — és követi a helyi $ref mutatókat ugyanazon dokumentumban. Az elavultként megjelölt végpontok teljesen kihagyhatók, és egy olyan dokumentum, amely nem néz ki OpenAPI-nak (nincs összetevő/séma vagy útvonalak szakasza), világos hibaüzenetet hoz létre az üres kimenet helyett.
Minden helyileg fut a böngészödben — az API specifikációd, amely egy nem még kiadott terméket vagy belső rendszert írhat le, soha nem töltődik fel sehová. Másolja ki az előállított típusokat, töltsd le .txt fájlként, hogy beilleszd egy .ts fájlba, vagy küldd egyenesen vissza a kimenetet a bemenetre, hogy folytathasd a finomítást.