Una aplicación de escritorio para editar, visualizar y validar especificaciones OpenAPI/Swagger.
- Editor con resaltado de sintaxis para YAML y JSON
- Previsualización en tiempo real utilizando Swagger UI
- Validación de especificaciones OpenAPI instantánea y en tiempo real
- Conversión entre formatos (YAML ↔ JSON)
- Proxy CORS integrado para probar endpoints directamente desde la interfaz
- Sistema de favoritos para acceso rápido a tus APIs frecuentes
- Historial de archivos recientes para retomar tu trabajo fácilmente
- Autoguardado para evitar pérdida de datos
- Diseño de interfaz dividida con editor y previsualización lado a lado
- Exportación de documentación en diferentes formatos (HTML, JSON, YAML)
-
Clona el repositorio:
git clone https://github.com/cmurestudillos/openapi-swagger.git cd openapi-swagger -
Instala las dependencias:
npm install -
Inicia la aplicación:
npm start
- Nuevo documento: Crea una nueva especificación OpenAPI en blanco
- Abrir archivo: Abre una especificación existente (JSON o YAML)
- Guardar/Guardar como: Guarda tu trabajo en el sistema de archivos
- Validación en tiempo real: Muestra errores mientras escribes
- Validación manual: Verifica toda la especificación con un clic
- Resaltado de errores: Localiza fácilmente problemas en el editor
- Previsualización interactiva: Interfaz Swagger UI completa
- Prueba de endpoints: Realiza peticiones directamente desde la aplicación
- Generación de documentación: Exporta documentación lista para publicar
- Favoritos: Marca tus APIs más utilizadas para acceso rápido
- Historial reciente: Accede a tus últimos archivos editados
- Autoguardado: Protección contra pérdida de datos (cada 10 minutos)
Puedes personalizar diversos aspectos de la aplicación:
- Intervalo de autoguardado: Modifica
autoSaveDelayenrenderer.js - Plantilla por defecto: Edita
defaultOpenAPIenrenderer.js - Temas del editor: Modifica
editor.setThemeenrenderer.js
Las contribuciones son bienvenidas. Por favor, sigue estos pasos:
- Fork el repositorio
- Crea una rama para tu característica (
git checkout -b feature/amazing-feature) - Haz commit de tus cambios (
git commit -m 'Add some amazing feature') - Push a la rama (
git push origin feature/amazing-feature) - Abre un Pull Request
- Electron - Framework para aplicaciones de escritorio
- Ace Editor - Editor de código para la web
- Swagger UI - Interfaz para visualizar APIs
- js-yaml - Conversión YAML ↔ JSON
- Express - Servidor para el proxy CORS
Este proyecto está licenciado bajo la licencia MIT - ver el archivo LICENSE para más detalles.