OpenAPI vers TypeScript
Générez des types TypeScript à partir des schémas d’un document OpenAPI 3 ou Swagger 2.0 au format YAML ou JSON. Chaque entrée sous components.schemas, ou sous definitions dans Swagger 2.0, devient une interface exportée ou un alias de type ; les liens $ref entre elles deviennent des noms de type et les champs nullables reçoivent | null.
Foire aux questions
Quelles parties du document sont converties ?
Les schémas sous components.schemas dans OpenAPI 3 et sous definitions dans Swagger 2.0. Les chemins, paramètres et réponses ne sont pas convertis en types ; référencez les types de schéma générés dans votre propre code de requête et de réponse.
Comment les noms de schéma sont-ils convertis en noms de type ?
Chaque clé de schéma est reconstruite en PascalCase : user-profile devient ainsi UserProfile. Lorsque deux clés produiraient le même nom, un numéro est ajouté à la seconde.
Les champs nullables sont-ils pris en charge ?
Oui. nullable: true d’OpenAPI 3.0 et x-nullable: true de Swagger 2.0 ajoutent | null ; les tableaux de types d’OpenAPI 3.1, comme ["string", "null"], deviennent string | null.
Que se passe-t-il pour les références que l’outil ne peut pas résoudre ?
Un $ref qui pointe en dehors du document ou vers autre chose qu’un schéma dans components.schemas ou definitions devient unknown et est indiqué dans un commentaire en tête de la sortie.
YAML est-il pris en charge ?
Oui. Collez le document au format YAML ou JSON. Les ancres et alias de YAML sont développés avant la conversion.
Comment vérifier le document au préalable ?
Utilisez le validateur OpenAPI, qui répertorie les problèmes structurels et les références incorrectes. Ce convertisseur lit uniquement les schémas et ne signale pas les autres erreurs.