WebhookDocs: Generate Swagger Preview of Your Active Workflows - n8n Workflow | Neura Market
WebhookDocs: Generate Swagger Preview of Your Active Workflows
# How it Works
This meta-workflow is designed to intelligently scan all your active workflows in n8n, identify those that contain Webhook nodes, and automatically generate a Swagger (OpenAPI) specification based on them.
The output Swagger document reflects all accessible endpoints from your Webhook nodes, making it easier to:
- Visualize your API structure
- Share your endpoints
- Integrate with tools like Postman or Swagger UI
## Enhanced Parameter Support
If you want the Swagger to reflect request parameters (e.g., query or body fields), you can annotate your Webhook nodes using the Note section. When configured properly, these annotations enrich your Swagger documentation with parameter names, types, and descriptions.
# Setup Steps
1. Add the WebhookDocs to n8n. Import the WebhookDocs JSON file into your n8n instance.
2. Activate the WebhookDocs (you can also use the test-endpoint). Annotate Webhook Nodes (Optional but Recommended). To enable parameter documentation, open the Note section of each Webhook node and add annotations in the following format:
```
//@body field_name string description
//@query field_name string description
```
3. Open the page https://n8n.yourinstance.com/webhook/swagger
Platform
n8n
Category
Development & IT
Price
Free
Creator
Danger
n8n
code
webhook
stickyNote
respondToWebhook
How to import this workflow into n8n
1Purchase or download the workflow to get the n8n workflow JSON file.
2In your n8n instance, open Workflows and choose "Import from File" (or paste the JSON with Ctrl+V on the canvas).
3Open each node marked with a credential warning and connect your own accounts and API keys.
4Run the workflow once manually to verify the data flow, then toggle it to Active.