OpenAPI a TypeScript
Convierte los schemas de componentes OpenAPI a interfaces y tipos TypeScript
Acerca de OpenAPI a TypeScript
Genera declaraciones TypeScript a partir de la sección components.schemas de un documento OpenAPI 3.x en JSON o YAML, mientras pegas o editas. Los schemas de tipo objeto se convierten en interfaces, con las propiedades que no figuran en required como opcionales y las descripciones como comentarios JSDoc; los enums, arrays y composiciones allOf, oneOf o anyOf pasan a ser alias de tipo. Práctico para tipar clientes y handlers de tu API sin sumar un generador de código a tu build.
Categoría: API.
Preguntas frecuentes
¿Genera tipos de solicitud y respuesta para cada endpoint?
▾
No. Solo se convierte components.schemas; los paths y las operaciones se ignoran. Las respuestas que referencian un schema de components pueden usar directamente el tipo generado; los schemas inline deben moverse antes a components.
¿Qué pasa con las referencias $ref?
▾
Un $ref a #/components/schemas/User se convierte en una referencia al tipo User y nunca se incrusta, así que los schemas recursivos o circulares funcionan. Las referencias a archivos externos o a otras secciones, como #/components/responses, no se resuelven y quedan como nombres de tipo inválidos que debes corregir a mano.
¿Se admiten nullable, format y las definitions de Swagger 2.0?
▾
No. Un nullable: true no agrega | null, los arrays de tipos de OpenAPI 3.1 como [integer, null] se convierten en string y format se ignora, así que date-time queda como string. Las definitions de Swagger 2.0 tampoco se leen, porque solo se usa components.schemas.
¿Necesito instalar alguna biblioteca en tiempo de ejecución?
▾
No. La salida son tipos TypeScript puros — se eliminan en tiempo de compilación y no agregan ninguna sobrecarga en tiempo de ejecución. Solo copia los tipos generados en tu proyecto.