Documentación

Guía de uso

1. Abrir o crear un documento

Archivo → Abrir acepta .yaml, .yml y .json. El botón Nuevo carga una plantilla OpenAPI 3.0 con un endpoint de ejemplo. La cabecera muestra el nombre del archivo; pasa el ratón por encima para ver la ruta completa.

2. Editar con vista previa

Al dejar de escribir, la documentación de la derecha se regenera con Swagger UI. Al abrir un archivo, el editor detecta si es JSON o YAML y ajusta el resaltado.

3. Validar

Dos segundos después de cada cambio se comprueba el documento: si hay un error de sintaxis, su línea se marca en rojo y la barra de estado muestra el motivo. El botón Validar (o OpenAPI → Validar) hace la misma comprobación y muestra el error en un diálogo.

4. Probar los endpoints

Despliega una operación en la vista previa, pulsa Try it out y luego Execute. La petición se envía a la URL de servers a través de un proxy local que solo atiende a la propia app, de modo que funciona aunque la API no devuelva cabeceras CORS.

5. Convertir, guardar y exportar

A JSON y A YAML convierten el documento. Guardar escribe el archivo abierto (o pide un nombre si es nuevo) y Exportar genera un .yaml, un .json o una página .html con la documentación, sin cambiar el archivo en el que estás trabajando.

6. Favoritos, recientes y autoguardado

La estrella ★ añade el archivo abierto a Archivo → Favoritos, y Archivo → Archivos recientes guarda los 10 últimos. Cada 10 minutos se guarda el archivo abierto; si el documento es nuevo, se guarda una copia temporal que la app ofrece recuperar al arrancar.

Limitaciones conocidas

• Validación Es básica: comprueba la sintaxis y que existan openapi/swagger, info y paths, pero no valida los esquemas ni resuelve las $ref.
• HTML La página exportada carga Swagger UI desde cdnjs, así que necesita conexión para verse.
• Guardar como Guarda el contenido tal cual: para obtener un .json a partir de YAML, convierte antes con A JSON o usa Exportar.
• Try it out La Request URL que muestra Swagger UI es la del proxy local, no la de tu API.

Arquitectura

├── main.js                  # proceso principal: ventana, menús, diálogos, IPC y configuración
├── preload.js               # puente IPC seguro (contextIsolation activo)
├── renderer.js              # interfaz: editor ACE, Swagger UI, validación y autoguardado
├── proxy-server.js          # proxy CORS local (Express, solo 127.0.0.1 y con token)
├── swagger-parser-loader.js # validación básica de la especificación
├── index.html · style.css   # estructura y estilos de la ventana
└── assets/                  # iconos de la app

Construida con Electron, ACE como editor, Swagger UI para la vista previa, js-yaml para las conversiones y Express para el proxy. Sin frameworks de interfaz: HTML, CSS y JavaScript.

Roadmap

• Validación Validación completa (esquemas y $ref) con swagger-parser
• Pestañas Varios documentos abiertos a la vez
• Snippets Fragmentos para los componentes OpenAPI más habituales
• Importar Colecciones de Postman e Insomnia
• Diff Comparación visual entre versiones de una especificación
• Tema Tema claro/oscuro para la aplicación

Contribuir

Los issues y pull requests son bienvenidos. Abre un issue describiendo el bug (si puedes, adjunta una especificación mínima que lo reproduzca) o la funcionalidad que echas de menos.