即時啟用 Webhook API 文件生成器 - n8n 工作流程

• 透過 n8n 管理多個 API 整合的開發人員。


• 需要一個集中化、可自動更新的 n8n Webhook 端點目錄的團隊。


• 希望簡化分享 n8n 工作流程設計的 API 規格的使用者。


• 想尋找使用 n8n 節點進行內省（introspection）進階範例的自動化專家。

管理大量的 n8n 工作流程 Webhook 容易變得複雜。這個強大的 n8n 工作流程透過自動檢視整個 n8n 環境來解決能見度的問題。它會使用內建的 n8n API 來收集所有啟用中工作流程及其內嵌 Webhook 節點的詳細資料，並將這些資料轉換成標準的 Swagger 2.0 規格。

產生的文件會透過互動式的 Swagger UI 直接在瀏覽器中呈現，只要呼叫 n8n 的觸發 Webhook 即可。這就省去了每次部署新的 n8n 工作流程或端點時都必須手動更新文件的麻煩，對 DevOps 和整合團隊來說價值極高。此外，它支援在 Webhook 備註中加入自訂註解，以便正確記錄查詢參數 (query) 和請求本文參數 (body)，使這個 n8n 範本在建構穩健的 API 層時特別實用。

1. 流程從名為 Get Swagger 的 n8n 觸發器開始，這是一個 HTTP Webhook，設定為使用下游節點來回應。


2. 接著，n8n 節點會對內建的 n8n API 發出請求，專門擷取環境中所有目前啟用中的 n8n 工作流程設定的詳細資料。


3. 核心邏輯位於 Code (代碼) n8n 節點中。此節點會處理原始工作流程的 JSON 資料。它會識別所有的 Webhook 節點及其對應的 Respond to Webhook 節點，分析其連接關係以判斷回應類型（JSON、純文字或重新導向）。


4. 關鍵在於，Code 節點會建構一個 Swagger 2.0 的 YAML 字串，擷取路徑 (path)、方法 (method)、回應碼 (response codes)，並動態加入參數說明文件，前提是原始 Webhook n8n 節點的備註中包含相關註解（例如：@query 或 @body）。


5. 最後，Respond to Webhook n8n 節點會將產生的 Swagger YAML 文字封裝進一個 HTML 範本中，該範本會初始化 Swagger UI 資源包。這樣會直接向請求者回傳一個互動式的說明文件頁面，提供了完全由 n8n 工作流程本身產生的動態文件來源。

1. 將提供的 n8n 工作流程 JSON 匯入到你的 n8n 環境中。


2. 憑證設定： 此 n8n 工作流程需要 n8n 節點（步驟 2）的憑證。你必須設定一個『n8n API』憑證，通常是在你的 n8n 設定中生成一個個人存取憑證 (PAT)。


3. 設定註解（選填但建議）： 為了確保 API 文件包含參數資訊，請開啟你任一啟用中工作流程中的 Webhook n8n 節點，並在『備註 (Notes)』欄位中加入參數定義，請遵循工作流程內便利貼（sticky note）上詳述的語法（例如：// @query my_id string 資源識別碼）。


4. 啟用： 儲存並啟用新的 n8n 工作流程。


5. 存取： 透過呼叫定義好的 Webhook URL（例如：https://your-n8n-instance/webhook/swagger）來存取你的即時文件。

Get Swagger (Webhook 觸發器)： 作為起點的 n8n 觸發器。它監聽 /swagger 路徑，並使用 responseNode 設定來等待最終輸出。
n8n (n8n 節點)： 使用內建的 n8n API 獲取所有啟用中 n8n 工作流程的資料。這確保了文件內容隨時與當前已部署的端點保持同步。
Code (自訂代碼節點)： 這是此 n8n 範本的自動化核心。它會解析工作流程結構、判斷 Webhook 與回應之間的連接，提取可選的參數註解，並仔細地將資料格式化為有效的 Swagger 2.0 YAML 字串。它包含了複雜的邏輯（findValidTargets）來追蹤 Webhook n8n 節點與 Respond to Webhook n8n 節點之間的連接關係。
Respond to Webhook (最終動作節點)： 作為 n8n 節點的最後一步，它將產生的 Swagger YAML 資料包裝進一個 HTML 外部殼層（wrapper）中。此殼層會載入 Swagger UI 的前端資源，並根據 n8n 工作流程產生的即時資料來呈現互動式的 API 文件預覽。