PostmanToSwagger

Una aplicación de escritorio elegante y eficiente que convierte colecciones de Postman a formato YAML para Swagger/OpenAPI 3.0. Simplifica la documentación de APIs transformando tus colecciones de Postman existentes en especificaciones OpenAPI compatibles con Swagger Editor.

✨ Características

🔄 Conversión intuitiva: Transforma colecciones Postman (.json) a YAML OpenAPI 3.0 con un solo clic
👁️ Vista previa en tiempo real: Visualiza el JSON de entrada y el YAML de salida en la misma interfaz
📁 Gestión de archivos sencilla: Carga y guarda archivos fácilmente con la interfaz nativa
📋 Copia rápida: Copia el YAML generado al portapapeles para usarlo en Swagger Editor
🔍 Inferencia inteligente: Genera automáticamente esquemas a partir de ejemplos JSON
📊 Registro detallado: Visualiza el progreso y los resultados del proceso de conversión

🚀 Instalación

Opción 1: Descargar ejecutable

Descarga el instalador apropiado para tu sistema operativo desde la sección de releases.

Opción 2: Construir desde el código fuente

# Clonar el repositorio
git clone hhttps://github.com/cmurestudillos/postman-to-swagger-converter.git
cd postman-to-swagger-converter

# Instalar dependencias
npm install

# Iniciar la aplicación
npm start

# Crear ejecutable (opcional)
npm run package

🖥️ Uso

Seleccionar archivo: Haz clic en "Seleccionar archivo Postman" para cargar tu colección (.json)
Convertir: Presiona el botón "Convertir" para generar el YAML de OpenAPI
Verificar: Revisa el resultado generado en el panel derecho
Exportar: Guarda el resultado como archivo YAML o cópialo al portapapeles
Utilizar: Importa el YAML en Swagger Editor o en tu herramienta preferida de OpenAPI

📘 Guía para mejores resultados

Para obtener conversiones óptimas, se recomienda:

Organizar en carpetas tus endpoints en Postman (se convertirán en tags en OpenAPI)
Usar nombres descriptivos para tus requests
Incluir ejemplos en los cuerpos de tus requests POST/PUT
Definir variables de entorno para las URLs base
Documentar tus endpoints con descripciones en Postman

🛠️ Tecnologías utilizadas

Electron - Framework para apps de escritorio
js-yaml - Conversión JSON/YAML
Lodash - Utilidades JavaScript
Node.js - Entorno de ejecución

🤝 Contribuciones

Las contribuciones son bienvenidas. Para cambios importantes:

Primero abre un issue para discutir qué te gustaría cambiar
Haz fork del repositorio
Crea una nueva rama (git checkout -b feature/amazing-feature)
Haz commit de tus cambios (git commit -m 'feat: añadir funcionalidad asombrosa')
Haz push a la rama (git push origin feature/amazing-feature)
Abre un Pull Request

📋 Tareas pendientes

Añadir editor integrado para modificar el YAML generado
Integrar vista previa con Swagger UI
Soportar autenticación y cabeceras complejas
Añadir opciones de personalización del formato
Implementar validación del YAML generado
Conversión inversa (de OpenAPI a Postman)

📄 Licencia

Este proyecto está licenciado bajo la Licencia MIT - ver el archivo LICENSE para más detalles.

🙏 Agradecimientos

Postman por su increíble herramienta para APIs
OpenAPI Initiative por el estándar OpenAPI
Swagger por sus herramientas de documentación de APIs

cmurestudillos/postman-to-swagger-converter