第二部分：核心概念与功能 → 节点 → 自定义节点 → 创建自定义节点

疯狂的赤泥

创建自定义节点是扩展 n8n 功能的关键。您可以通过以下两种主要方式创建：

• 使用 n8n CLI (命令行界面):
  • 安装 n8n CLI: 如果您尚未安装，需要先通过 npm 或 yarn 进行安装。
  • 创建节点项目: 使用 n8n create node <nodeName> 命令创建一个新的节点项目。<nodeName> 是您自定义节点的名称（例如，my-custom-api）。
  • 项目结构: CLI 会生成包含必要文件和文件夹的结构，例如：
    • nodes/my-custom-api/: 包含节点定义和执行逻辑的 JavaScript 或 TypeScript 文件 (my-custom-api.node.ts 或 .js)。
    • nodes/my-custom-api/my-custom-api.credentials.ts (可选): 用于定义节点所需的凭证。
    • nodes/my-custom-api/tests/: 包含节点测试文件的目录。
    • package.json: 项目依赖和脚本定义。
      
  • 开发节点: 您需要在生成的 .node.ts 或 .js 文件中定义节点的描述、输入/输出端口、参数和核心的 execute 方法。
  • 开发凭证 (如果需要): 如果您的节点需要凭证，您需要在 .credentials.ts 文件中定义凭证的结构和获取方式。
  • 编写测试: 在 tests 目录下编写测试用例以验证节点的行为。
  • 构建和链接: 使用 npm run build 或 yarn build 构建项目，然后使用 n8n link <your-node-directory> 将其链接到您的 n8n 实例。
    
• 手动创建节点文件:
  • 创建节点目录和文件: 在您的 n8n 自定义节点目录下（需要在 n8n 的配置文件中指定），手动创建一个新的文件夹（例如 my-custom-node）并在其中创建一个 JavaScript 或 TypeScript 文件（例如 my-custom-node.node.js 或 .ts）。
  • 定义节点描述: 在您的节点文件中，您需要导出一个包含节点描述信息的对象，包括 type（必须是 n8n-nodes-base.node）、description、version、inputs、outputs、icon 和 properties（定义节点的参数）。
  • 实现 execute 方法: 这是节点的核心逻辑，它是一个异步函数，接收输入数据并返回处理后的输出数据。您需要在这里编写代码来执行您的自定义操作。
  • 定义凭证 (如果需要): 如果节点需要凭证，您需要在单独的文件中定义凭证的结构，并在节点定义中引用它。
  • 编写测试 (推荐): 虽然是手动的，但强烈建议您创建测试文件来验证节点的正确性.
    
  
  

无论您选择哪种方式，都需要深入了解 n8n 的节点开发 API 和规范。n8n 的官方文档提供了详细的指南和示例，可以帮助您创建功能强大的自定义节点。