# OpenAPI į TypeScript

Generuoja TypeScript tipus iš OpenAPI 3 arba Swagger 2.0 dokumento schemų, pateiktų YAML arba JSON formatu. Kiekvienas components.schemas elementas arba Swagger 2.0 apibrėžtis tampa eksportuojama sąsaja arba tipo pseudonimu; $ref nuorodos tarp jų tampa tipų pavadinimais, o nulinę reikšmę galintys turėti laukai gauna | null.

## Dažnai užduodami klausimai

### Kurios dokumento dalys konvertuojamos?

OpenAPI 3 schemos, esančios components.schemas, ir Swagger 2.0 schemos, esančios definitions. Paths, parametrai ir atsakymai nepaverčiami tipais; sugeneruotus schemų tipus naudokite savo užklausų ir atsakymų kode.

### Kaip schemų pavadinimai paverčiami tipų pavadinimais?

Kiekvienas schemos raktas atkuriamas PascalCase forma, todėl user-profile tampa UserProfile. Jei du raktai gautų tą patį pavadinimą, prie antrojo pridedamas skaičius.

### Ar palaikomi laukai, galintys turėti null reikšmę?

Taip. OpenAPI 3.0 nullable: true ir Swagger 2.0 x-nullable: true prideda | null, o OpenAPI 3.1 tipų masyvai, pavyzdžiui, ["string", "null"], tampa string | null.

### Kas nutinka nuorodoms, kurių įrankis negali išspręsti?

$ref, nurodantis už dokumento ribų arba į elementą, kuris nėra components.schemas ar definitions esanti schema, tampa unknown ir išvardijamas komentare išvesties viršuje.

### Ar palaikomas YAML?

Taip. Įklijuokite dokumentą kaip YAML arba JSON. Prieš konvertavimą išplečiami YAML inkarai ir pseudonimai.

### Kaip pirmiausia patikrinti dokumentą?

Naudokite OpenAPI Validator, kuris pateikia struktūrines problemas ir neveikiančias nuorodas. Šis konverteris tik nuskaito schemas ir nepraneša apie kitas klaidas.

Jūsų reklama čia?

[Parašykite mums el. paštu](mailto:hi@dennn.is?subject=Reklama%20svetain%C4%97je%20OneClick%20Pro)

[Reklama 433 įrankių jūsų DI agentams per vieną MCP serverį.](https://multitaskai.com/lt/?ref=oneclickpro)
