@osumi/swagger-to-angular
v1.0.0
Published
Utilidad CLI para generar servicios Angular desde Swagger
Readme
@osumi/swagger-to-angular
Herramienta CLI para generar servicios e interfaces Angular a partir de un archivo Swagger/OpenAPI.
Convierte automáticamente un Swagger JSON en un servicio .ts que incluye:
- Todas las interfaces del apartado
components.schemas - Todos los métodos HTTP (
get,post,put,delete) del apartadopaths - Firma de parámetros y tipos de retorno
- Gestión de errores HTTP
- Uso de
inject(HttpClient)y entorno compatible con Angular 20+
🚀 Instalación
Global (para usarlo como comando en cualquier proyecto)
npm install -g @osumi/swagger-to-angularLocal (dentro de un proyecto)
npm install --save-dev @osumi/swagger-to-angularLuego puedes usarlo con npx:
npx swagger-to-angular <opciones>🧪 Uso
swagger-to-angular [ -u <url> | -f <archivo> ] -d <directorio>-u, --url <url>: URL al JSON Swagger-f, --file <archivo>: Ruta local a un archivo JSON Swagger-d, --dest <directorio>: Ruta donde se generará el archivo.ts
Es obligatorio indicar
-d, y uno de-uo-f(pero no ambos).
✅ Ejemplos:
# Leer desde una URL
swagger-to-angular -u http://localhost:8080/api-docs.json -d src/app/services/api
# Leer desde un archivo local
swagger-to-angular -f ./swagger.json -d src/app/services/api⚙️ Desarrollo local
Para contribuir o probar el proyecto localmente:
# Clona el repositorio o trabaja en tu directorio local
npm install
npm run build
# Ejecutar localmente con tsx
npx tsx bin/cli.ts -f ./swagger.json -d src/api
# O probar como si estuviera instalado globalmente
npm link
swagger-to-angular -f ./swagger.json -d src/apiℹ️ Nota sobre npm run
Si quieres ejecutar con npm run, usa -- para pasar argumentos correctamente:
npm run start -- -f ./swagger.json -d src/api📜 Licencia
MIT
