社区节点验证指南#

希望 n8n 验证您的节点吗？ 如果您准备提交节点供 n8n 验证，在构建节点时请遵循以下指南。启用已验证社区节点的用户，可以在所有部署类型（自托管和 n8n Cloud）中通过 n8n 节点面板发现并安装已验证节点。

使用 n8n-node 工具#

所有已验证社区节点作者都应强烈考虑使用 n8n-node 工具 来创建和检查他们的软件包。这有助于 n8n 通过以下方式确保质量和一致性：

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

软件包源码验证#

• 验证您的 npm 包仓库 URL 是否与预期的 GitHub（或其他平台）仓库匹配
• 确认 npm 和代码仓库中的包作者/维护者信息一致
• 确认 npm 中的 git 链接有效且代码仓库为公开状态
• 确保您的软件包包含完整文档（README、使用示例等）
• 确保您的软件包采用 MIT 许可证

无外部依赖#

• 确保您的软件包不包含任何外部依赖，以保持轻量化和易维护性

完整文档#

• 提供清晰的文档，可以是 GitHub 上的 README 文件或相关 API 文档 链接
• 包含使用说明、工作流示例以及必要的身份验证详情

禁止访问环境变量或文件系统#

• 代码严禁与环境变量交互或尝试读写文件
• 所有必要数据都应通过节点参数传递

遵循 n8n 最佳实践#

• 保持清晰一致的编码风格
• 使用 TypeScript 并遵循 n8n 的 节点开发指南
• 确保正确的错误处理和验证机制
• 确保通过代码检查（即运行 npx @n8n/scan-community-package n8n-nodes-PACKAGE 能够通过）

仅使用英文#

• 节点界面和所有文档必须仅使用英文
• 包括参数名称、描述说明、帮助文本、错误信息和 README 内容

与文档交流 本页面 点赞有帮助 点踩无帮助 感谢您的反馈！ 提交 上一页 UX 指南 下一页 测试节点 基于 Material for MkDocs Insiders 构建