OpenAPI uz TypeScript
Ģenerējiet TypeScript tipus no OpenAPI 3 vai Swagger 2.0 dokumenta shēmām formātā YAML vai JSON. Katrs ieraksts sadaļā components.schemas vai Swagger 2.0 definitions kļūst par eksportētu saskarni vai tipa aizstājvārdu; $ref saites starp tām kļūst par tipu nosaukumiem, bet nullējamie lauki iegūst | null.
Bieži uzdotie jautājumi
Kuras dokumenta daļas tiek pārveidotas?
OpenAPI 3 gadījumā tiek pārveidotas shēmas sadaļā components.schemas, bet Swagger 2.0 gadījumā — sadaļā definitions. Ceļi, parametri un atbildes netiek pārvērsti tipos; izmantojiet ģenerētos shēmu tipus savā pieprasījumu un atbilžu kodā.
Kā shēmu nosaukumi tiek pārveidoti par tipu nosaukumiem?
Katras shēmas atslēga tiek pārveidota PascalCase formā, tāpēc user-profile kļūst par UserProfile. Ja divu atslēgu nosaukumi būtu vienādi, otrajam tiek pievienots skaitlis.
Vai tiek atbalstīti nullējamie lauki?
Jā. OpenAPI 3.0 nullable: true un Swagger 2.0 x-nullable: true pievieno | null, bet OpenAPI 3.1 tipu masīvi, piemēram, ["string", "null"], kļūst par string | null.
Kas notiek ar atsaucēm, kuras rīks nevar atrisināt?
$ref, kas norāda ārpus dokumenta vai uz elementu, kas nav shēma sadaļā components.schemas vai definitions, kļūst par unknown un tiek norādīta komentārā izvades sākumā.
Vai tiek atbalstīts YAML?
Jā. Ielīmējiet dokumentu kā YAML vai JSON. Pirms pārveidošanas tiek izvērsti YAML enkuri un aizstājvārdi.
Kā vispirms pārbaudīt dokumentu?
Izmantojiet OpenAPI validatoru, kas uzskaita strukturālās problēmas un bojātās atsauces. Šis pārveidotājs nolasa tikai shēmas un neziņo par citām kļūdām.