Escáner OpenAPI en Desktop
Genera OpenAPI 3.1 desde el código de tu backend: escaneo estructural rápido e inferencia opcional con IA local.
Genera un archivo OpenAPI 3.1 (openapi.json) a partir de la carpeta de tu proyecto backend, sin necesidad de ejecutar la API ni escribir la spec a mano.
Qué hace el escáner
- Explora el proyecto y localiza archivos con rutas HTTP (controllers,
routes/,handlers/,Program.cs, etc.). - Extrae métodos, paths y, cuando el código lo permite, DTOs/modelos para
components.schemas. - Genera
openapi.jsony muestra un resumen del análisis (archivos revisados, operaciones, esquemas enlazados). - Opcionalmente puedes subir el archivo a un workspace de Capydox web.
El flujo por defecto es escaneo estructural: rápido, solo CPU, no requiere modelo de IA. La inferencia con IA es opcional (ver Privacidad de la IA local).
Cómo usarlo (paso a paso)
1. Abrir la herramienta
En Capydox Desktop, ve a Escanear OpenAPI (menú lateral).
2. Elegir la carpeta del backend
Pulsa Elegir carpeta del proyecto y selecciona la raíz del repositorio (donde está pom.xml, package.json, go.mod, Cargo.toml, etc.).
Opcional: indica un título de la API; se usará en info.title del OpenAPI.
3. Analizar
Pulsa Analizar API. Verás una barra de progreso. Al terminar aparece OpenAPI generado con el resumen y acciones (copiar ruta, abrir carpeta, subir).
4. Revisar el resultado
- Resumen del análisis: qué se hizo (archivos, operaciones, esquemas).
- Notas: avisos puntuales si los hubo (por ejemplo, inferencia de IA omitida).
5. Subir al workspace (opcional)
Con sesión iniciada: elige workspace, spec nuevo o reemplazo, y Subir OpenAPI.
Stacks compatibles
Si tu stack no está listado, escribe a support@capydox.com.
Opciones avanzadas: inferir esquemas con IA
Opciones avanzadas → Inferir esquemas con IA.
| Escaneo estructural (por defecto) | + IA opcional | |
|---|---|---|
| Rutas HTTP | Sí | Sí (mismas rutas) |
| DTOs del código | Sí, si existen en el repo | Sí + muestra extra inferida |
| Modelo ~4 GB | No necesario | Obligatorio descargarlo |
| Tiempo | Segundos / pocos minutos | Puede tardar bastante más |
| Privacidad | Todo local, sin LLM | Ver privacidad |
Buenas prácticas
- Apunta a la carpeta raíz del API, no a todo un monorepo si solo necesitas un módulo.
- Mantén rutas en archivos reconocibles (
*Controller.java,routes/*.js,routers/*.py,handlers/*.go). - Limpiar artefactos borra análisis antiguos en disco local (por defecto, más de 7 días).