n8n Webhook API文档自动生成器工作流 - Swagger规范自动生成
n8n,Webhook,Swagger,API文档,自动化,Code节点,OpenAPI,API集成

这个元工作流旨在智能扫描n8n中所有活跃的工作流,识别包含Webhook节点的流程,并基于它们自动生成Swagger(OpenAPI)规范文档。

生成的Swagger文档反映了所有可访问的Webhook节点端点,使您能够:

– 可视化API结构
– 共享端点信息
– 与Postman或Swagger UI等工具集成

增强的参数支持

如果您希望Swagger文档反映请求参数(例如查询或正文字段),可以使用Note部分注释Webhook节点。当正确配置时,这些注释将通过参数名称、类型和描述来丰富您的Swagger文档。

设置步骤

1. 将WebhookDocs添加到n8n
– 将WebhookDocs JSON文件导入到您的n8n实例中
– 激活WebhookDocs(也可以使用测试端点)

2. 注释Webhook节点(可选但推荐)
– 要启用参数文档,请打开每个Webhook节点的Note部分,并按以下格式添加注释:
//@body field_name string description
//@query field_name string description

3. 访问页面 https://n8n.youristance.com/webhook/swagger

工作流包含以下核心节点:
– n8n节点:扫描活跃工作流
– Code节点:处理逻辑和生成Swagger规范
– Webhook节点:提供API端点
– Respond to Webhook节点:返回Swagger UI界面
– Sticky Note节点:提供配置说明

声明:本站所有文章,如无特殊说明或标注,均为本站原创发布。任何个人或组织,在未征得本站同意时,禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益,可联系我们进行处理。