OpenAPI per TypeScript
Genera tipi TypeScript dagli schemi di un documento OpenAPI 3 o Swagger 2.0 in YAML o JSON. Ogni voce in components.schemas o, per Swagger 2.0, in definitions diventa un'interfaccia o un alias di tipo esportato; i collegamenti $ref tra loro diventano nomi di tipo e i campi nullable ricevono | null.
Domande frequenti
Quali parti del documento vengono convertite?
Gli schemi in components.schemas in OpenAPI 3 e in definitions in Swagger 2.0. Percorsi, parametri e risposte non vengono convertiti in tipi; fai riferimento ai tipi degli schemi generati nel tuo codice per le richieste e le risposte.
Come vengono convertiti i nomi degli schemi in nomi di tipo?
Ogni chiave dello schema viene ricostruita in PascalCase: user-profile diventa UserProfile. Quando due chiavi genererebbero lo stesso nome, alla seconda viene aggiunto un numero.
I campi nullable sono supportati?
Sì. nullable: true di OpenAPI 3.0 e x-nullable: true di Swagger 2.0 aggiungono | null; gli array type di OpenAPI 3.1, come ["string", "null"], diventano string | null.
Che cosa succede ai riferimenti che lo strumento non riesce a risolvere?
Un $ref che punta fuori dal documento o a qualcosa che non sia uno schema in components.schemas o definitions diventa unknown e viene elencato in un commento all'inizio dell'output.
YAML è supportato?
Sì. Incolla il documento come YAML o JSON. Gli anchor e gli alias in YAML vengono espansi prima della conversione.
Come posso controllare prima il documento?
Usa il validatore OpenAPI, che elenca i problemi strutturali e i riferimenti non validi. Questo convertitore legge soltanto gli schemi e non segnala altri errori.