n8n 中文文档

社区节点验证指南

提示

Do you want n8n to verify your node? 您想让 n8n 验证您的节点吗?

如果您想提交节点以供 n8n 验证,请在构建节点时遵循这些准则。任何启用了经过验证的社区节点的用户都可以从 n8n 的节点面板跨所有部署类型(自托管和 n8n 云)发现并安装经过验证的节点。

提示

Upcoming Changes 即将发生的变化

从 2026 年 5 月 1 日起,您必须使用 GitHub 操作发布 ALL 社区节点并包含 出处声明

使用n8n节点工具

所有经过验证的社区节点作者都应使用 n8n-node 工具 创建并检查其包。这有助于 n8n 通过以下方式确保质量和一致性:

  • 生成预期的包文件结构
  • 向 package.json 文件添加必需的元数据和配置
  • 使您能够轻松地根据 n8n 的标准检查代码
  • 允许您在本地 n8n 实例中加载节点进行测试

节点类型

  • 节点不得与现有官方节点重复;若你的节点是对现有节点的迭代,请改为提交拉取请求。
  • n8n 目前不接受逻辑或流程控制类节点。
  • 每个包应只集成一个第三方服务。包装多个无关 API 或作为多服务代理层的包通常不符合验证要求。请为每个服务分别提交独立包。
  • 你可以在主节点旁加入同一服务的触发器节点。由于声明式样式不支持触发器,请使用编程式样式构建触发器节点。一个包可以混用两种样式,因此声明式操作节点和编程式触发器节点可以放在同一个包中。

包源码验证

  • 验证您的 npm 包存储库 URL 与预期的 GitHub 存储库匹配。
  • 确认包作者/维护者在 npm 和存储库之间匹配。
  • 确认 npm 中的 git 链接有效且存储库是公开的。
  • 确保您的包有适当的文档(README、使用示例等)。
  • 确保您的包许可证是 MIT。
  • 包应通过 GitHub Actions 发布,并包含 provenance。

无外部依赖

  • 确保您的包不包含任何外部依赖项,以保持轻量级和易于维护。

正确文档

  • 提供清晰的文档,无论是 GitHub 上的 README 还是相关 API 文档的链接。
  • 包括使用说明、示例工作流和任何必要的身份验证详细信息。

无法访问环境变量或文件系统

  • 代码不得与环境变量交互或尝试读取/写入文件。
  • 通过节点参数传递所有必要的数据。

遵循 n8n 最佳实践

  • 保持清晰一致的编码风格。
  • 使用 TypeScript 并遵循 n8n 的节点开发指南。
  • 确保正确处理错误并进行验证。
  • 确保 linter 通过(换句话说,确保运行 npx @n8n/scan-community-package n8n-nodes-PACKAGE 通过)。

仅使用英语

  • 节点界面和所有文档都必须仅使用English。
  • 这包括参数名称、描述、帮助文本、错误消息和 README 内容。

相关资源

不想自己部署和维护 n8n?n8ncn 托管 n8n 云服务:开通账号即可使用,不用买服务器;也可以在 n8ncn 工作流库 找现成的中文工作流。