OpenAPI u TypeScript tipove
Pretvori dokument OpenAPI ili Swagger u TypeScript sučelja i tipove.
OpenAPI u TypeScript tipove
Zalijepi dokument OpenAPI 3 ili Swagger 2 — JSON ili YAML — i ovaj alat generira podudarajuća TypeScript sučelja za svaku shemu u components/schemas, plus jedan tip po endpointu za njegove putanje i parametre upita, tijelo zahtjeva i odgovore. Uštedi korak ručnog pisanja API tipova svaki put kada se specifikacija promijeni, i drži klijenta usklađenim s onim što server zapravo vraća.
Mogućnosti kontroliraju oblik izlaza. Odaberite interface ili type deklaracije, i odlučite kako se polja koja dopuštaju null predstavljaju: kao opcionalno svojstvo (x?: string) ili kao unija s null-om (x: string | null). $ref reference mogu ostati kao imenovani tipovi koji pokazuju na podudarajuće sučelje, ili biti rasširene u redu gdje se koriste. Isključite "generiraj putanju, parametar i tipove odgovora" da dobijete samo sheme komponenti, ili uključite uniju statusnog koda da vidite svaki kod odgovora koji endpoint može vratiti kao jedan tip. Opisi iz specifikacije postaju JSDoc komentari iznad svakog polja, a prefiks imena sprječava da se generirani tipovi sudare s vašima kada ih zalijepite u veću bazu koda.
Parser čita standardne OpenAPI konstrukte — object i array sheme, enume, oneOf/anyOf/allOf, nullable, additionalProperties — i slijedi lokalne $ref pokazivače unutar istog dokumenta. Endpointi označeni kao zastarjeli mogu se potpuno preskočiti, a dokument koji ne izgleda kao OpenAPI (nema components/schemas ili paths sekcije) proizvodi jasnu grešku umjesto praznog izlaza.
Svega se izvršava lokalno u vašem pregledniku — vaša specifikacija API-ja, koja može opisati neizdani proizvod ili interni sustav, nikada nije učitana nigdje. Kopirajte generirane tipove, preuzmite ih kao .txt datoteku da zalijepite u .ts datoteku, ili pošaljite izlaz ravno natrag na unos da ga nastavite dorađivati.