OpenAPI v TypeScript tipe
Pretvori dokument OpenAPI ali Swagger v TypeScript vmesnike in tipe.
OpenAPI v TypeScript tipe
Prilepite dokument OpenAPI 3 ali Swagger 2 — JSON ali YAML — in to orodje ustvari ustrezne TypeScript vmesnike za vsako shemo v components/schemas, plus en tip na končno točko za njegove poti in parametre poizvedbe, telo zahtevka in odgovore. Prihrani korak ročnega pisanja tipov API vsakič, ko se specifikacija spremeni, in ohrani odjemalca usklađenega s tem, kar strežnik dejansko vrne.
Mogočnosti nadzirajo obliko rezultata. Izberite interface ali type deklaracije in se odločite, kako so polja, ki dovolijo null, predstavljena: kot neobvezna lastnost (x?: string) ali kot unija z null (x: string | null). Reference $ref lahko ostanejo kot poimenovani tipi, ki kažejo na ustrezen vmesnik, ali pa so razširjene v redu, kjer se jih uporablja. Izklopite »ustvari tipe poti, parametrov in odgovorov«, da dobite samo sheme komponent, ali pa vklopite unijo statusa kode, da vidite vsak kodo odgovora, ki jo lahko vrne končna točka, kot en tip. Opisi iz specifikacije postanejo JSDoc komentarji nad vsakim poljem, predpona imena pa preprečuje, da bi se generirani tipi trčili z vašimi, ko jih prilepite v večjo kodno bazo.
Parser prebere standardne OpenAPI konstrukte — object in array sheme, enume, oneOf/anyOf/allOf, nullable, additionalProperties — in sledi lokalnim kazalcem $ref v istem dokumentu. Končne točke, označene kot zastarele, se lahko v celoti preskočijo, dokument, ki ne izgleda kot OpenAPI (nima razdelkov components/schemas ali paths), pa izdela jasno napako namesto praznega rezultata.
Vse se izvršuje lokalno v vašem brskalniku — vaša specifikacija API-ja, ki lahko opisuje neizdan proizvod ali notranji sistem, nikoli ni posredovana nikamor. Kopirajte generirane tipe, jih preuzmite kot datoteko .txt, da jo prilepite v datoteko .ts, ali pošljite rezultat naravnost nazaj na vnos, da ga nadaljujete z izboljšanjem.