Saltar al contenido

OpenAPI a TypeScript

Genera tipos TypeScript a partir de los esquemas de un documento OpenAPI 3 o Swagger 2.0 en YAML o JSON. Cada entrada bajo components.schemas o, en Swagger 2.0, bajo definitions, se convierte en una interfaz o alias de tipo exportado; los enlaces $ref entre ellos se convierten en nombres de tipo, y los campos anulables incluyen | null.

Restablecer

Preguntas frecuentes

¿Qué partes del documento se convierten?

Los esquemas bajo components.schemas en OpenAPI 3 y bajo definitions en Swagger 2.0. Las rutas, los parámetros y las respuestas no se convierten en tipos; haz referencia a los tipos de esquema generados desde tu propio código de solicitud y respuesta.

¿Cómo se convierten los nombres de los esquemas en nombres de tipo?

Cada clave de esquema se reconstruye en PascalCase; por ejemplo, user-profile se convierte en UserProfile. Si dos claves dan el mismo nombre, se añade un número a la segunda.

¿Se admiten los campos anulables?

Sí. nullable: true de OpenAPI 3.0 y x-nullable: true de Swagger 2.0 añaden | null, y las matrices de tipos de OpenAPI 3.1, como ["string", "null"], se convierten en string | null.

¿Qué ocurre con las referencias que la herramienta no puede resolver?

Una referencia $ref que apunta fuera del documento o a algo que no sea un esquema en components.schemas o definitions se convierte en unknown y se incluye en un comentario al principio del resultado.

¿Se admite YAML?

Sí. Pega el documento como YAML o JSON. Los anclajes y alias de YAML se expanden antes de la conversión.

¿Cómo puedo comprobar primero el documento?

Usa el Validador de OpenAPI, que enumera los problemas estructurales y las referencias rotas. Este conversor solo lee los esquemas y no informa de otros errores.

Acerca de OneClick Pro

OneClick Pro es una colección gratuita de más de 150 herramientas web para las tareas cotidianas: convertir imágenes y unidades, dar formato y validar código, consultar dominios y SEO, y trabajar con texto, fechas y números. Todas las herramientas funcionan sin registro ni suscripción; los datos que introduce solo se utilizan para calcular el resultado y nunca se almacenan. Úsela como una caja de herramientas para tareas puntuales o añada a favoritos las que utiliza a diario.