웹훅을 위한 동적 API 문서 포털 - n8n 워크플로우

자동화 아키텍트: n8n을 기반으로 구축된 마이크로서비스를 표준화하고 자동으로 문서를 생성하려는 사용자.
테크니컬 라이터: 배포된 n8n 워크플로우 로직과 직접 연동되는 실시간 자동 업데이트 문서 시스템이 필요한 팀.
개발자: n8n 트리거가 제공하는 엔드포인트에 대한 cURL 명령어 및 스키마 정의에 쉽게 접근해야 하는 분.
n8n 파워 유저: 고급 인스턴스 관리 및 메타 자동화 기능을 활용하는 모든 사용자.

수많은 웹훅 엔드포인트에 대한 문서를 최신 상태로 유지하는 것은 지루하고 번거로운 작업이 될 수 있습니다. 이 강력한 n8n 워크플로우는 메타 자동화 엔진 역할을 함으로써 이 문제를 해결합니다. n8n API 전용 노드를 사용하여 인스턴스 내의 모든 활성 워크플로우를 검사합니다.

핵심 로직은 중요한 규칙에 기반합니다. 즉, 문서화를 목적으로 하는 모든 n8n 워크플로우에는 APIDOCS라는 이름의 특별한 Set n8n 노드가 포함되어야 합니다. 이 노드에는 요약, 요청/응답 본문, 메서드와 같은 표준화된 메타데이터가 담겨 있습니다. 생성기는 이 APIDOCS n8n 노드를 스캔하여 데이터를 추출하고, 동적으로 아름답고 인터랙티브한 Bootstrap 테마의 문서 페이지를 구성합니다.

이 시스템을 사용하면 n8n 워크플로우 바로 옆에서 문서를 관리할 수 있어 API 포털이 배포된 로직과 항상 동기화되도록 보장합니다. 이는 자체 호스팅 환경을 위한 가장 복잡하고 유용한 n8n 템플릿 중 하나입니다.

이 자동화는 공개 액세스 단계와 생성 단계의 두 단계로 작동합니다.

공개 액세스 (문서 제공):

1. 주요 진입점은 /api-doc에 구성된 Webhook n8n 트리거입니다. 이 URL로 요청이 오면 플로우가 시작됩니다.


2. Configs n8n 노드는 포털 제목, 버전, n8n 인스턴스의 기본 URL과 같은 전역 변수를 정의합니다.


3. 그런 다음 플로우는 ExecuteSubWorkflow n8n 노드를 통해 하위 워크플로우를 실행하며 필요한 구성 데이터를 전달합니다.


4. MakeFullHTML n8n 노드는 하위 워크플로우에서 생성된 원시 HTML 문서 콘텐츠를 받아 다크 모드 Bootstrap 스타일을 사용하여 완전한 HTML 페이지로 감쌉니다.


5. 마지막으로 RespondHTML n8n 노드는 최종 생성된 HTML을 최초의 웹훅을 호출한 브라우저로 다시 전송합니다.

생성 단계 (콘텐츠 빌드):

1. 생성 프로세스는 Execute n8n 트리거로 시작되며, 입력값이 GetWorkflows n8n 노드로 전달됩니다.


2. GetWorkflows n8n 노드는 n8n API 자격 증명을 사용하여 인스턴스 내의 모든 활성 n8n 워크플로우 메타데이터를 가져옵니다.


3. Aggregate n8n 노드는 전체 워크플로우 목록을 수집합니다.


4. 핵심은 FilterWorkflows 커스텀 코드(Custom Code) n8n 노드입니다. 이 노드는 워크플로우 목록을 반복하면서 Webhook n8n 트리거와 API_DOCS n8n 노드를 모두 포함하는 워크플로우만 필터링합니다. 메타데이터를 파싱하고, cURL 명령어를 구성하며, 문서화된 각 엔드포인트에 대해 최종 n8n 워크플로우에서 표시될 준비가 된 HTML 아코디언 마크업을 생성합니다.

이 포괄적인 문서화 n8n 워크플로우를 배포하려면 다음 단계를 따르십시오:

1. 가져오기: 제공된 n8n 워크플로우 JSON을 n8n 인스턴스로 가져옵니다.


2. API 자격 증명: GetWorkflows n8n 노드를 구성해야 합니다. 인스턴스의 모든 워크플로우를 읽을 수 있는 권한을 가진 n8n API 자격 증명을 설정해야 합니다.


3. 전역 설정: Configs n8n 노일을 맞춤 설정합니다. namedoc, version, 특히 urlbase를 실제 공개 URL(예: https://my.n8n.app/)과 일치하도록 수정하십시오.


4. 웹훅 문서화: 포털에 표시하려는 모든 n8n 워크플로우에 Set n8n 노드를 추가하고 이름을 APIDOCS로 지정합니다(대소문자 구분).


5. 메타데이터 JSON: APIDOCS n8n 노드 내부에서 'Raw' JSON 모드를 사용하여 대상 webhook 이름, summary, method, requestBody, 샘플 successResponse를 포함한 엔드포인트 메타데이터를 정의합니다.


6. 활성화: 생성기 n8n 워크플로우와 모든 대상 웹훅을 저장하고 활성화합니다. 문서는 메인 Webhook n8n 트리거로 정의된 URL(예: [YourN8NURL]/webhook/api-doc)에서 사용할 수 있습니다.

Webhook (트리거): 주요 공개 액세스 n8n 트리거. 기능: /api-doc에서 액세스할 때 문서 생성 및 제공 프로세스를 시작합니다. 주요 구성: 응답 모드를 'Response Node'로 설정.
GetWorkflows (n8n 노드): 기능: n8n API를 사용하여 모든 활성 n8n 워크플로우의 JSON 배열을 가져옵니다. 주요 구성: 읽기 액세스를 위한 특정 n8n API 자격 증명이 필요합니다.
Configs (Set n8n 노드): 기능: 문서 페이지의 전역 설정을 저장합니다(제목, 버전, 기본 URL).
FilterWorkflows (Code n8n 노드): 기능: 복잡한 커스텀 코드 로직이 포함되어 있으며, 워크플로우 목록을 필터링하고, API_DOCS JSON 메타데이터를 파싱하며, cURL 예제를 생성하고, 최종 Bootstrap HTML 문서 구조를 구성합니다.
ExecuteSubWorkflow (Execute Workflow n8n 노드): 기능: 생성 로직 경로(GetWorkflows -> FilterWorkflows)를 비동기적으로 호출하여 HTML 콘텐츠를 생성합니다. 주요 구성: 하위 워크플로우 완료를 기다립니다.
MakeFullHTML (HTML n8n 노드): 기능: 생성 단계에서 나온 htmlContent 출력을 받아 Bootstrap 5를 사용하여 일관된 다크 모드 모양을 보장하는 전체 HTML 페이지 템플릿에 삽입합니다.

• RespondHTML (Respond to Webhook n8n 노드): 기능: 최종 생성된 HTML을 최초의 n8n 트리거를 호출한 사용자에게 응답으로 반환하는 마지막 작업입니다.