What is docfy-ui
UI de documentación OpenAPI AI-first, proyecto companion de nestjs-docfy. Una referencia de API ligera y moderna con un botón Copy for AI en cada endpoint.


Motivación
La mayoría de UIs de OpenAPI están construidas para humanos escaneando una página, que es el formato equivocado para el otro público que hoy lee documentación: un LLM al que le estás pegando contexto. Copiar los detalles de un endpoint normalmente significa coger el JSON crudo (verboso, lleno de $ref y ruido) o copiar el HTML renderizado (pierde la estructura).
Ejemplo: Copy for AI
Un clic en "Copy for AI" en el mismo endpoint:
text
## Create a user
POST /users
### Request
{
"name": "string",
"email": "string"
}
### Responses
201 Created (UserEntity)
400 Bad Request
### Validation
- name: required, minLength 2
- email: required, format emaildocfy-ui renderiza este texto de forma determinista a partir del mismo documento OpenAPI que ya sirve cualquier Swagger UI, sin anotaciones extra y sin cambios en el backend.
Features
- Copy for AI: cada endpoint obtiene un resumen en texto plano, listo para LLM, con un clic (purpose, request, responses, reglas de validación) en vez de JSON crudo.
- Copy OpenAPI: copia el fragmento JSON desreferenciado y a prueba de ciclos, solo del endpoint seleccionado.
- Two-column endpoint view: documentación a la izquierda (parámetros, respuestas, árbol de schema navegable), snippets de código a la derecha (curl, JavaScript, Python, Go).
- Real-time search: filtra el sidebar por path/summary/operationId en cada pulsación de tecla, sin debounce, sin tecla Enter.
- Dark/light theme: basado en tokens, cambia al instante sin reload y sin flash en el primer render.
- Zero backend coupling: obtiene un documento JSON OpenAPI 3.0/3.1 del lado del cliente; funciona con cualquier servidor que exponga uno, no solo NestJS.
- Mobile-responsive: drawer off-canvas por debajo del breakpoint
lg, auditado a 375/390/768px. - Compare specs: pega dos URLs de spec y ve los endpoints añadidos/eliminados/modificados, cada uno marcado como breaking o informativo.
- Multi-spec switcher: navega por varios servicios desde una instancia cuando el host configura más de una spec, oculto por completo en caso contrario.

