Generador de documentación de API para Webhooks activos - Flujo de trabajo de n8n

• Desarrolladores que gestionan múltiples integraciones de API a través de n8n.


• Equipos que necesitan un directorio centralizado y autoadaptable de sus endpoints de webhook de n8n.


• Usuarios que desean simplificar el intercambio de especificaciones de API para sus diseños de flujos de trabajo de n8n.


• Especialistas en automatización que buscan ejemplos avanzados del uso del nodo de n8n para introspección.

Gestionar numerosos webhooks de flujos de trabajo de n8n puede volverse complejo. Este potente flujo de trabajo de n8n soluciona el problema de visibilidad al realizar una introspección automática de toda la instancia de n8n. Utiliza la API interna de n8n para recopilar detalles sobre todos los flujos de trabajo activos y sus nodos Webhook integrados, transformando estos datos en una especificación estándar Swagger 2.
0.

La documentación resultante se presenta a través de una Swagger UI interactiva renderizada directamente en el navegador cuando se invoca el webhook de activación de n8n. Esto elimina la necesidad de actualizaciones manuales de la documentación cada vez que se implementa un nuevo flujo de trabajo o endpoint en n8n, lo cual aporta un valor significativo a los equipos de DevOps e integración. Además, admite anotaciones personalizadas en las notas del webhook para documentar correctamente los parámetros de consulta y del cuerpo, haciendo que esta plantilla de n8n sea excepcionalmente útil para construir capas de API robustas.

1. El proceso comienza con el disparador (trigger) de n8n Get Swagger, que es un Webhook HTTP configurado para responder usando un nodo posterior.


2. El nodo n8n de n8n ejecuta entonces una solicitud contra la API interna de n8n, recuperando específicamente los detalles de todas las configuraciones de flujos de trabajo activas en la instancia.


3. La lógica central reside en el nodo Code de n8n. Este nodo procesa los datos JSON brutos del flujo de trabajo. Identifica todos los nodos Webhook y sus correspondientes nodos Responder a Webhook, analizando las conexiones para determinar el tipo de respuesta (JSON, texto o redirección).


4. Fundamentalmente, el nodo Code construye una cadena YAML de Swagger 2.0, extrayendo la ruta, el método, los códigos de respuesta y añadiendo dinámicamente la documentación de parámetros si el nodo n8n Webhook original tiene anotaciones relevantes en sus notas (ej. @query o @body).


5. Finalmente, el nodo Respond to Webhook de n8n toma el texto YAML de Swagger generado y lo incrusta dentro de una plantilla HTML que inicializa el paquete Swagger UI. Esto entrega una página de documentación interactiva directamente al solicitante, ofreciendo una fuente de documentación completa y dinámica generada por el propio flujo de trabajo de n8n.

1. Importa el JSON del flujo de trabajo de n8n proporcionado a tu instancia de n8n.


2. Configuración de credenciales: Este flujo de trabajo de n8n requiere credenciales para el nodo n8n (Paso 2). Debes configurar una credencial de 'API de n8n', normalmente generando un Token de Acceso Personal (PAT) dentro de tu configuración de n8n.


3. Configurar anotaciones (Opcional pero recomendado): Para asegurar que tu documentación de API incluya parámetros, abre el nodo Webhook de n8n en cualquiera de tus flujos de trabajo activos y usa el campo 'Notas' para añadir definiciones de parámetros, siguiendo la sintaxis detallada en la nota adhesiva del flujo de trabajo (ej. // @query my_id string El identificador del recurso).


4. Activar: Guarda y activa el nuevo flujo de trabajo de n8n.


5. Acceso: Accede a tu documentación en vivo llamando a la URL del webhook definida (ej. https://your-n8n-instance/webhook/swagger).

Get Swagger (Disparador Webhook): El disparador inicial de n8n. Escucha en la ruta /swagger y utiliza la configuración responseNode para esperar la salida final.
n8n (Nodo n8n): Recupera todos los datos de los flujos de trabajo activos de n8n usando la API interna de n8n. Esto asegura que la documentación esté siempre actualizada con los endpoints desplegados actualmente.
Code (Nodo de Código Personalizado): Este es el motor de automatización de esta plantilla de n8n. Analiza la estructura del flujo de trabajo, determina las conexiones de respuesta del webhook, extrae las notas de parámetros opcionales y formatea meticulosamente los datos en una cadena YAML válida de Swagger 2.0. Incluye lógica compleja (findValidTargets) para rastrear las conexiones entre un nodo n8n Webhook y un nodo n8n Responder a Webhook.
Respond to Webhook (Nodo de Acción Final): El nodo final de n8n que empaqueta los datos Swagger YAML generados en un envoltorio HTML. Este envoltorio carga los recursos front-end de Swagger UI, renderizando la vista previa interactiva de la documentación de la API basada en los datos en vivo generados por el flujo de trabajo de n8n.