OpenAPI în TypeScript
Generați tipuri TypeScript din schemele unui document OpenAPI 3 sau Swagger 2.0 în YAML sau JSON. Fiecare intrare din components.schemas sau din definitions în Swagger 2.0 devine o interfață exportată sau un alias de tip; legăturile $ref dintre ele devin nume de tipuri, iar câmpurile nullable primesc | null.
Întrebări frecvente
Ce părți ale documentului sunt convertite?
Schemele din components.schemas în OpenAPI 3 și din definitions în Swagger 2.0. Căile, parametrii și răspunsurile nu sunt transformate în tipuri; folosiți tipurile generate pentru scheme în propriul cod de cerere și răspuns.
Cum sunt transformate numele schemelor în nume de tipuri?
Fiecare cheie de schemă este refăcută în PascalCase, astfel încât user-profile devine UserProfile. Când două chei ar produce același nume, celei de-a doua i se adaugă un număr.
Sunt acceptate câmpurile nullable?
Da. nullable: true din OpenAPI 3.0 și x-nullable: true din Swagger 2.0 adaugă | null, iar tablourile de tipuri OpenAPI 3.1, precum ["string", "null"], devin string | null.
Ce se întâmplă cu referințele pe care instrumentul nu le poate rezolva?
Un $ref care indică în afara documentului sau către altceva decât o schemă din components.schemas ori definitions devine unknown și este menționat într-un comentariu la începutul rezultatului.
Este acceptat YAML?
Da. Lipiți documentul ca YAML sau JSON. Ancora și aliasurile din YAML sunt extinse înainte de conversie.
Cum verific mai întâi documentul?
Folosiți Validatorul OpenAPI, care listează problemele structurale și referințele invalide. Acest convertor citește doar schemele și nu raportează alte erori.