OpenAPI a tipos TypeScript
Convierte un documento OpenAPI o Swagger en interfaces y tipos de TypeScript.
OpenAPI a tipos TypeScript
Pega un documento OpenAPI 3 o Swagger 2 — JSON o YAML — y esta herramienta genera interfaces TypeScript coincidentes para cada esquema en components/schemas, más un tipo por punto final para sus parámetros de ruta y consulta, cuerpo de solicitud y respuestas. Ahorra el paso de escribir manualmente tipos de API cada vez que cambia la especificación, y mantiene el cliente sincronizado con lo que el servidor realmente devuelve.
Las opciones controlan la forma de la salida. Elige declaraciones interface o type, y decide cómo se representan los campos anulables: como una propiedad opcional (x?: string) o como una unión con null (x: string | null). Las referencias $ref pueden permanecer como tipos nombrados que apunten a la interfaz coincidente, o expandirse en línea dondequiera que se usen. Desactiva "generar tipos de ruta, parámetro y respuesta" para obtener solo los esquemas de componentes, o activa una unión de código de estado para ver cada código de respuesta que un punto final puede devolver como un único tipo. Las descripciones de la especificación se convierten en comentarios JSDoc encima de cada campo, y un prefijo de nombre evita que los tipos generados colisionen con los tuyos cuando los pegas en una base de código más grande.
El analizador lee construcciones OpenAPI estándar — esquemas de objeto y array, enumeraciones, oneOf/anyOf/allOf, nullable, additionalProperties — y sigue punteros $ref locales dentro del mismo documento. Los puntos finales marcados como obsoletos pueden omitirse por completo, y un documento que no parezca OpenAPI (sin sección components/schemas o paths) produce un error claro en lugar de una salida en blanco.
Todo se ejecuta localmente en tu navegador — tu especificación de API, que puede describir un producto no lanzado o un sistema interno, nunca se sube a ningún lado. Copia los tipos generados, descárgalos como archivo .txt para pegar en un archivo .ts, o envía la salida directamente nuevamente a la entrada para seguir refinándola.