Preskoči na vsebino

OpenAPI v TypeScript

Ustvarite tipe TypeScript iz shem dokumenta OpenAPI 3 ali Swagger 2.0 v YAML ali JSON. Vsak element pod components.schemas oziroma definitions v Swagger 2.0 postane izvožen vmesnik ali vzdevek tipa; povezave $ref med njimi postanejo imena tipov, ničelna polja pa dobijo | null.

Ponastavi

Pogosta vprašanja

Kateri deli dokumenta se pretvorijo?

Sheme pod components.schemas v OpenAPI 3 in pod definitions v Swagger 2.0. Poti, parametri in odzivi se ne pretvorijo v tipe; ustvarjene tipe shem uporabite v svoji kodi zahtev in odzivov.

Kako se imena shem pretvorijo v imena tipov?

Vsak ključ sheme se pretvori v PascalCase, zato user-profile postane UserProfile. Če bi dva ključa ustvarila isto ime, se drugemu doda številka.

Ali so podprta ničelna polja?

Da. nullable: true iz OpenAPI 3.0 in x-nullable: true iz Swagger 2.0 dodata | null, polja tipa OpenAPI 3.1, kot je ["string", "null"], pa postanejo string | null.

Kaj se zgodi s sklici, ki jih orodje ne more razrešiti?

$ref, ki kaže zunaj dokumenta ali na nekaj, kar ni shema v components.schemas ali definitions, postane unknown in je naveden v komentarju na vrhu izhoda.

Ali je podprt YAML?

Da. Prilepite dokument kot YAML ali JSON. Sidra in vzdevki v YAML se pred pretvorbo razširijo.

Kako naj najprej preverim dokument?

Uporabite validator OpenAPI, ki navede strukturne težave in nedelujoče sklice. Ta pretvornik prebere samo sheme in ne poroča o drugih napakah.

O spletnem mestu OneClick Pro

OneClick Pro je brezplačna zbirka z več kot 150 spletnimi orodji za vsakodnevno delo: za pretvarjanje slik in enot, oblikovanje in preverjanje kode, preverjanje domen in SEO ter delo z besedilom, datumi in števili. Vsako orodje deluje brez registracije ali naročnine, vnesene podatke pa uporabimo samo za izračun rezultata in jih nikoli ne shranimo. Zbirko lahko uporabljate kot priročen nabor orodij za posamezna opravila ali si dodate med zaznamke orodja, ki jih uporabljate vsak dan.