Herramienta de línea de comandos que genera SDK de clientes API, esqueletos de servidor y documentación HTML a partir de una definición OpenAPI/Swagger.
17,8 mil+3 esta semana5,9 milMustacheApache-2.0Actualizado hace 3 días
openapi-ts/openapi-typescript
Genera tipos de TypeScript a partir de esquemas OpenAPI 3 e incluye un cliente fetch con seguridad de tipos basado en ellos.
- Estrellas
- 8,428
- Forks
- 675
- Issues abiertos
- 287
- Último commit
- el mes pasado
¿Qué es?
openapi-typescript es un monorepo con dos paquetes para trabajar con esquemas OpenAPI en TypeScript. El paquete principal, openapi-typescript, convierte un esquema OpenAPI 3 estático en definiciones de tipos de TypeScript, de modo que las rutas de las solicitudes, los parámetros y los cuerpos de las respuestas se puedan comprobar en tiempo de compilación, en lugar de escribirlos a mano.
El segundo paquete, openapi-fetch, es un wrapper ligero de fetch que utiliza esos tipos generados. Las solicitudes y las respuestas se tipan según el esquema, por lo que las discrepancias entre el código del cliente y la definición de la API se manifiestan como errores de TypeScript.
El proyecto está dirigido a equipos de frontend y full-stack que ya mantienen una descripción OpenAPI de su API y quieren código de cliente tipado sin tener que escribirlo ni mantenerlo manualmente.
Funciones clave
- 01Convierte esquemas OpenAPI 3 estáticos en definiciones de tipos de TypeScript.
- 02Incluye openapi-fetch, un cliente fetch tipado a partir de los tipos generados del esquema.
- 03Detecta en tiempo de compilación las discrepancias entre las llamadas del cliente y las definiciones de la API.
- 04Admite OpenAPI 3.1, según indican los temas del proyecto.
Casos de uso
- Generar modelos tipados de cliente API para una aplicación frontend a partir del archivo OpenAPI del backend.
- Crear un cliente fetch con seguridad de tipos para una API REST existente.
- Mantener los tipos del cliente sincronizados con un esquema de API que cambia mediante CI.
Inicio rápido
- 1
Instala openapi-typescript desde npm
npm i -D openapi-typescript typescript - 2
Genera tipos a partir de un esquema OpenAPI
npx openapi-typescript https://petstore3.swagger.io/api/v3/openapi.json -o ./petstore.d.ts
Temas
Preguntas frecuentes
- ¿Qué es openapi-typescript?
- Genera tipos de TypeScript a partir de esquemas OpenAPI 3 e incluye un cliente fetch con seguridad de tipos basado en ellos. openapi-typescript es un monorepo con dos paquetes para trabajar con esquemas OpenAPI en TypeScript. El paquete principal, openapi-typescript, convierte un esquema OpenAPI 3 estático en definiciones de tipos de TypeScript, de modo que las rutas de las solicitudes, los parámetros y los cuerpos de las respuestas se puedan comprobar en tiempo de compilación, en lugar de escribirlos a mano.
- ¿openapi-typescript es gratuito? ¿Qué licencia tiene?
- openapi-typescript es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
- ¿openapi-typescript sigue mantenido?
- Actualizado en los últimos 6 meses. El último commit de openapi-typescript fue el 25 sept 2026.
- ¿Para qué puedo usar openapi-typescript?
- Generar modelos tipados de cliente API para una aplicación frontend a partir del archivo OpenAPI del backend. Crear un cliente fetch con seguridad de tipos para una API REST existente. Mantener los tipos del cliente sincronizados con un esquema de API que cambia mediante CI.
- ¿Cómo se instala openapi-typescript?
- Instala openapi-typescript desde npm: npm i -D openapi-typescript typescript Genera tipos a partir de un esquema OpenAPI: npx openapi-typescript https://petstore3.swagger.io/api/v3/openapi.json -o ./petstore.d.ts
- ¿Dónde consigo openapi-typescript?
- El código fuente y las instrucciones de instalación están en GitHub: https://github.com/openapi-ts/openapi-typescript
Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.
Proyectos relacionados
Herramienta de línea de comandos y biblioteca de Go que generan código base para servidores, clientes de API y modelos a partir de especificaciones OpenAPI 3.0 y 3.1.
8,7 mil+13 esta semana1,1 milGoApache-2.0Bien mantenidoActualizado anteayer
Kit de herramientas OpenAPI/Swagger de código abierto con una referencia interactiva de API, un cliente de API offline-first e integraciones para numerosos frameworks web.
16,4 mil+31 esta semana966TypeScriptMITActualizado hace 12 horas
Genera SDK de cliente, esqueletos de servidor y documentación en decenas de lenguajes y frameworks a partir de especificaciones OpenAPI (v2 y v3).
26,9 mil+8 esta semana7,8 milJavaApache-2.0Actualizado hace 16 horas
Biblioteca Java que genera especificaciones OpenAPI a partir de anotaciones del código y API REST de JAX-RS, con compatibilidad con OpenAPI 3.x.
7,5 mil+3 esta semana2,3 milJavaApache-2.0Bien mantenidoActualizado anteayer
Una cadena de herramientas Swagger/OpenAPI para .NET y ASP.NET Core que genera especificaciones de API a partir de controladores y clientes C# o TypeScript a partir de especificaciones.
7,4 mil1,4 milC#MITActualizado hace 2 meses