Документация workflow n8n с OpenAI
JSON workflow превращается в краткую документацию с описанием назначения, запуска и требований. В n8n OpenAI формирует текст по заголовку и JSON, полученным через форму.
Оригинал на n8n.io: Auto document your n8n workflows — Marvin Wu
Открыть шаблон на n8n.io бесплатно- Сложность
- простой4 вида узлов
- Просмотров на n8n.io
- 11 275
- Опубликован
- Обновлён
- Автор
- Marvin Wu
- Сверено
Что делает шаблон
Документация содержит краткое введение, описание механизма запуска и требования к настройке. Для webhook приводятся тестовый и рабочий URL, для расписания — cron-график; также перечисляются нужные учётные данные и внешние зависимости. Текст строится по заголовку и JSON workflow, отправленным через форму. URL формы можно изменить под домен и конфигурацию n8n, а структуру документации — через запрос в узле OpenAI. Дополнительные узлы позволяют передавать результат в другие системы, например публиковать его в вики или отправлять по электронной почте.
Как работает workflow по шагам
- Форма n8n запускает workflow после отправки заголовка и JSON.
- Узел Edit Fields (Set) обрабатывает полученные поля.
- Узел OpenAI генерирует документацию по данным workflow.
- Узел Respond to Webhook возвращает сформированный ответ.
Что нужно для запуска
- Учётные данные OpenAI API, настроенные в n8n.
- Форма с заголовком и JSON workflow.
Как подключить OpenAI к n8n
Для узла OpenAI нужны учётные данные API OpenAI, настроенные в n8n; они позволяют использовать модель GPT для генерации текста документации.
Что изменить под себя
- URL формы или вебхука меняются под домен и конфигурацию n8n.
- Запрос в узле OpenAI редактируется, чтобы изменить структуру или содержание документации.
- Дополнительные узлы можно добавить для публикации документации в вики или отправки по электронной почте.
Кому подойдёт
Workflow предназначен для пользователей и разработчиков n8n, которым нужно автоматизировать документацию. Он также подходит командам, стремящимся к единообразному описанию workflow.
Сервисы 1
Категории у источника: Извлечение данных из документов , Мультимодальный ИИ
Узлы workflow 4
- Edit Fields (Set)
- Respond to Webhook
- n8n Form Trigger
- OpenAI
Виды узлов, из которых собран сценарий, — как их перечисляет страница шаблона. Серым — служебные узлы n8n.
Автор и первоисточник
Сценарий «Auto document your n8n workflows» опубликовал на n8n.io Marvin Wu. Файл шаблона и авторское описание — на странице шаблона.
Русское описание написано языковой моделью по странице шаблона и прошло автоматическую проверку: в нём нет сервисов и чисел, которых нет у автора. Сценарий принадлежит автору; каталог его не хранит.