OpenAPI do TypeScript typov
Premeniť dokument OpenAPI alebo Swagger na TypeScript interfejsy a typy.
OpenAPI do TypeScript typov
Vložte dokument OpenAPI 3 alebo Swagger 2 — JSON alebo YAML — a tento nástroj generuje zodpovedajúce TypeScript interfejsy pre každé schéma v components/schemas, plus jeden typ na každý endpoint s jeho cestou, query parametrami, telesom požiadavky a odpoveďami. Ušetrí krok ručného písania API typov zakaždým, keď sa špecifikácia zmení, a udržuje klienta v súlade s tým, čo server vracia.
Volby ovládajú tvar výstupu. Vyberte si deklarácie interface alebo type a rozhodnite sa, ako sú reprezentované nullable polia: ako voliteľná vlastnosť (x?: string) alebo ako unión s null (x: string | null). Referencie $ref môžu buď zostať ako pomenované typy ukazujúce na zodpovedajúci interface, alebo byť rozšírené inline kdekoľvek sa používajú. Vypnite "generovať typy ciest, parametrov a odpovedí" ak chcete iba schémy komponentov, alebo zapnite union stavových kódov, aby ste videli všetky kódy odpovedí, ktoré môže endpoint vrátiť ako jeden typ. Opisy zo špecifikácie sa stanú JSDoc komentármi nad každým poľom, a predpona názvu udržiava generované typy od kolidovania s vašimi, keď ich vložíte do väčšej kódovej základne.
Parser čita štandardné OpenAPI konštrukty — object a array schémy, enumerácie, oneOf/anyOf/allOf, nullable, additionalProperties — a sleduje lokálne pointery $ref v rámci toho istého dokumentu. Endpointy označené ako zastarané sa dajú úplne preskočiť, a dokument, ktorý nevyzerá ako OpenAPI (bez components/schemas alebo sections ciest) produkuje jasný error namiesto prázdneho výstupu.
Všetko sa spúšťa lokálne vo vašom prehliadači — vaša špecifikácia API, ktorá môže popisovať nevydaný produkt alebo interný systém, sa nikdy nikam neuploaduje. Skopírujte generované typy, stiahnite si ich ako .txt súbor na vloženie do .ts súboru, alebo pošlite výstup priamo späť do inputu, aby ste ho ďalej vylepšili.