Steg 2: anslut n8n API-åtkomst

Det här workflowet läser alla aktiva workflows från er n8n-instans för att bygga Swagger-specifikationen.

1. Lägg till noden Fetch n8n Workflows och anslut den till Incoming Swagger Hook.
2. Ställ in Filters → Active Workflows på true.
3. Autentiseringsuppgifter krävs: Anslut era n8nApi-autentiseringsuppgifter.

Steg 3: konfigurera bearbetning av Swagger-spec

Bearbetningssteget tolkar workflow-data och bygger Swagger YAML, och använder hosten från den inkommande requesten för att sätta API-host.

1. Lägg till noden Build Swagger Spec och anslut den till Fetch n8n Workflows.
2. Ställ in JavaScript Code till följande script:
   function safe(x) { return x.replaceAll(":","").replaceAll("/","|") } function findValidTargets(connections, sourceNode, potentialTargets) { const visited = new Set(); const foundTargets = new Set(); function dfs(node) { if (visited.has(node)) return; visited.add(node); if (potentialTargets.includes(node)) { foundTargets.add(node); return; // Optionally continue search if multiple paths to same target are needed } const nodeConnections = connections[node]?.main || []; for (const path of nodeConnections) { for (const next of path) { dfs(next.node); } } } dfs(sourceNode); return Array.from(foundTargets); } const nodes = [] for (const item of $input.all()) { let webhook = { name: item.json.name, id: item.json.id, webhooks: [] } const webhook_call = item.json.nodes.filter(node =>node.type=='n8n-nodes-base.webhook'); const webhook_resp = item.json.nodes.filter(node =>node.type=='n8n-nodes-base.respondToWebhook'); const targets = webhook_resp.map(wr => wr.name); if(webhook_call.length) { for(const call of webhook_call) { const callName = call.name; if(call?.parameters?.responseMode == "responseNode") { const valid = findValidTargets(item.json.connections, callName, targets); call.responses = webhook_resp.filter(wr => valid.includes(wr.name)) } } webhook.webhooks.push(...webhook_call); nodes.push(webhook); } } let s = ` swagger: "2.0" info: title: N8N Instance API description: API description in Markdown. version: 1.0.0 host: ${$('Incoming Swagger Hook').first().json?.headers?.host || 'n8n.instance.com'} basePath: /webhook schemes: - https paths: ` for(const node of nodes) { const used_path = {}; for(const w of node.webhooks) { let path = ''; if(!(w?.parameters?.path in used_path)) { path = w?.parameters?.path; used_path[path] = true; } let produces = "application/json" let code = 200; if(w?.responses?.length) { for(const r of w.responses) { switch(r?.parameters?.respondWith) { case 'text': produces ='text/plain'; break case 'redirect': produces = 'redirect'; code = 301 break case 'json': produces = 'application/json'; break } } } let parameters = [] if(w?.notes) { console.log({notes: w.notes}) const params = w?.notes?.split('\n').filter(p => p.startsWith('@')); for(const p of params) { const parts = p.split(' '); const [position, name, type] = parts; const description = parts.slice(3).join(' '); console.log(p.split(' ')) switch(position) { case '@query': parameters.push(` - name: ${name} in: ${position.replaceAll('@', '')} description: ${description || 'no description'} type: ${type} required: true `) break case '@body': parameters.push(` - name: ${name} in: ${position.replaceAll('@', '')} description: ${description || 'no description'} schema: type: object required: - ${name} properties: ${name}: type: ${type} `) } } if(parameters.length) { parameters.unshift(` parameters: `) } } s+=` ${path ? `/${path}:` : ''} ${w?.parameters?.httpMethod?.toLowerCase() || 'get'} : summary: ${safe(w?.name) || safe(node.name)}. description: Related to workflow [${node.id}]. tags: - ${safe(node.name)} ${parameters.join('\n')} produces: - ${produces} responses: ${code}: description: OK` } } return {json:{text: s, nodes}};

Steg 4: konfigurera webhook-svarets output

Returnera en Swagger UI HTML-sida som renderar den genererade YAML:en.

1. Lägg till noden Return Webhook Output och anslut den till Build Swagger Spec.
2. Ställ in Respond With på text.
3. Ställ in Response Body till följande uttrycksbaserade HTML-mall:
   =
   ⚠️ Vanlig fallgrop: Om ni ersätter token {{ $json.text }} i HTML:en kommer Swagger UI att rendera en tom eller ogiltig spec.

   Steg 5: testa och aktivera ert workflow

   Validera webhook-outputen och aktivera workflowet för löpande användning.

   1. Klicka på Execute Workflow för att öppna en testsession.
   2. Skicka en request till URL:en för Incoming Swagger Hook (t.ex. via webbläsare eller HTTP-klient).
   3. Bekräfta en lyckad körning: Fetch n8n Workflows ska returnera workflow-data, Build Swagger Spec ska ge en YAML-sträng och Return Webhook Output ska rendera en Swagger UI-sida.
   4. Slå på Active för workflowet för att aktivera användning i produktion.
   🔒

   Lås upp fullständig steg-för-steg-guide

   Få den kompletta implementeringsguiden + nedladdningsbar mall

   Lås upp nu →

   Vanliga fallgropar

   • n8n-credentials kan löpa ut eller kräva specifika behörigheter. Om skanningen plötsligt inte returnerar något, kontrollera först credentials som används för att hämta workflows i inställningarna för din n8n-instans.
   • Om du använder Wait-noder eller extern rendering varierar processtiderna. Öka väntetiden om nedströms noder misslyckas på grund av tomma svar.
   • Swagger UI och Postman blir bara så korrekta som dina annoteringar. Standardprompter i AI-noder är generiska. Lägg in er tonalitet tidigt, annars kommer du att redigera utdata för alltid.

   Relaterade workflows

   Om ditt team också behöver ett enkelt sätt att dela endpoint-detaljer utanför utveckling, passar Slack-anpassade webhook-dokument från Google Sheets bra eftersom det gör ett underhållet kalkylark till något hela organisationen kan använda.

   För team som gör mycket kundonboarding och processöverlämningar hjälper OpenAI till Notion, tydlig processdokumentation vid begäran dig att skapa “så här använder du det”-lagret som Swagger inte täcker.

   När frågor fortsätter komma in efter att du levererat (och det kommer de), kan OpenAI + Slack: omedelbara svar från dina PDF:er minska supportpings genom att låta folk självserva från dina faktiska dokumentations-PDF:er.

   Behöver du något lättviktigt för att dela uppdateringar med intressenter som inte vill ha rå API-dokumentation? PDF till OpenAI, omedelbara ämnessammanfattningar du kan dela ger snabba sammanfattningar som kompletterar din levande Swagger-spec.

   Slutligen, om du vill gå från “dokumenterade endpoints” till “riktiga leveranser”, är Postman till Google Drive, signerade PDF:er levereras snabbt ett bra nästa steg eftersom det använder Postman-triggade flöden för att skapa och leverera filer pålitligt.

   
   

   Snabbreferens:

   • Slack-anpassade webhook-dokument från Google Sheets: Dela endpoint-information från ett underhållet kalkylark.
   • OpenAI till Notion, tydlig processdokumentation vid begäran: Generera lättläst processdokumentation för överlämningar.
   • OpenAI + Slack: omedelbara svar från dina PDF:er: Låt Slack svara på frågor utifrån PDF:er.
   • PDF till OpenAI, omedelbara ämnessammanfattningar du kan dela: Sammanfatta dokumentation snabbt för icke-tekniska intressenter.
   • Postman till Google Drive, signerade PDF:er levereras snabbt: Trigga Postman-flöden för att leverera signerade PDF:er.

   Vanliga frågor

   Hur lång tid tar det att sätta upp den här automatiseringen av Swagger-dokumentation?

   Cirka 20 minuter om du redan har n8n-åtkomst på plats.

   Behöver jag kunna koda för att automatisera Swagger-dokumentation?

   Nej, ingen kodning krävs för grundsetupen. Du importerar främst workflowet, kopplar credentials och testar swagger-endpointen.

   Är n8n gratis att använda för det här workflowet för automatisering av Swagger-dokumentation?

   Ja. n8n har ett gratis alternativ för egen drift och en gratis provperiod på n8n Cloud. Cloud-planer börjar på 20 USD/månad för högre volym. Du behöver också räkna in användning av Swagger UI/Postman (oftast gratis) och eventuella hostingkostnader.

   Var kan jag hosta n8n för att köra den här automatiseringen?

   Två alternativ: n8n Cloud (hanterat, enklast att komma igång) eller egen drift på en VPS. För egen drift är Hostinger VPS prisvärd och hanterar n8n bra. Egen drift ger obegränsat antal körningar men kräver grundläggande serverhantering.

   Kan jag anpassa det här workflowet för automatisering av Swagger-dokumentation för parameterdokumentation?

   Ja, och det är den bästa uppgraderingen du kan göra. Lägg till annoteringar i varje Webhook-nods Notes-sektion, som //@body email string Användarens e-postadress eller //@query source string Kampanjkälla, så kommer den genererade Swaggern att inkludera de fälten. Om ni standardiserar formatet i teamet blir dokumentationen märkbart tydligare. Du kan också exkludera vissa workflows (endast interna, kundspecifika) genom att justera filtreringslogiken i stegen “Fetch n8n Workflows” och “Build Swagger Spec”.

   Varför misslyckas min n8n-anslutning i det här workflowet?

   Oftast beror det på utgångna credentials eller saknade behörigheter för att läsa workflows. Uppdatera credentials som används i steget “Fetch n8n Workflows” och kör sedan swagger-endpointen igen. Om du kör egen drift bakom auth, bekräfta även att base URL och eventuella nödvändiga headers är korrekta.

   Hur många endpoints kan den här automatiseringen av Swagger-dokumentation hantera?

   Många. På n8n Cloud beror det på din plans körningsgränser, och vid egen drift beror det på din server. I praktiken är det normalt att generera en Swagger-fil för dussintals webhook-endpoints eftersom det bara handlar om att läsa workflows och returnera JSON.

   Är den här automatiseringen av Swagger-dokumentation bättre än att använda Zapier eller Make?

   För det här användningsfallet, ja. Zapier och Make kan trigga webhooks, men de kan inte på ett naturligt sätt “inspektera” din automationsmiljö och generera en OpenAPI-spec från den, och du slår snabbt i begränsningar om du försöker underhålla dokumentation som separata steg. n8n låter dig dessutom köra egen drift, vilket är användbart när din docs-endpoint bara ska vara intern. Om allt du behöver är en enkel webhook-relä i två steg kan de verktygen vara okej. Men för levande dokumentation kopplad till dina faktiska workflows är n8n ett renare val. Prata med en automationsexpert om du vill ha hjälp att välja.

   När det här är på plats slutar din webhook-dokumentation vara ett återkommande måste och börjar fungera som infrastruktur. Sätt upp det, dela en länk och gå vidare.