标准参数

这些是节点基础文件的标准参数。它们对于所有节点类型都是相同的。

displayName#

字符串|必填

这是用户在 n8n GUI 中看到的名称。

name#

字符串|必填

对象的内部名称。用于从节点中的其他地方引用它。

icon#

字符串或对象|必需

为特定节点指定图标。n8n 建议上传您自己的图像文件。

您可以将图标文件名作为字符串提供，也可以将其作为对象提供，以便处理亮色和暗色模式下的不同图标。如果图标在亮色和暗色模式下均可正常工作，请使用以 开头的字符串，指示图标文件的路径。例如：

1

icon: 'file:exampleNodeIcon.svg'

1
2
3
4

icon: { 
  light: 'file:exampleNodeIcon.svg', 
  dark: 'file:exampleNodeIcon.dark.svg' 
}

n8n 建议使用 SVG 作为节点图标，但您也可以使用 PNG。如果使用 PNG，图标分辨率应为 60x60px。节点图标的长宽比应为正方形或近似正方形。

group#

字符串数组|必需

告诉 n8n 工作流运行时节点的行为方式。选项包括：

• ：节点等待触发。
• ：节点等待计时器到期。
• 、、 ：这些目前没有效果。
• 空数组， 。如果不需要或 ，请使用此作为默认选项。

description#

字符串|必填

节点的简短描述。n8n 在 GUI 中使用它。

defaults#

对象|必填

包含必要的品牌和名称设置。

该对象可以包括：

• ：字符串。如果太长，则用作画布上的节点名称。
• ：字符串。十六进制颜色代码。提供集成的品牌颜色，以便在 n8n 中使用。

forceInputNodeExecution#

布尔值|可选

构建多输入节点时，您可以选择强制所有分支上的所有前置节点在节点运行之前执行。默认设置是（仅要求一个输入分支运行）。

inputs#

字符串数组|必需

命名输入连接器。控制节点在输入端的连接器数量。如果只需要一个连接器，请使用。

outputs#

字符串数组|必需

命名输出连接器。控制节点在输出端的连接器数量。如果只需要一个连接器，请使用。

requiredInputs#

整数或数组|可选

用于多输入节点。指定输入数字，这些输入必须包含数据（其分支必须运行）才能执行节点。

credentials#

对象数组|必需

此参数告知 n8n 凭证选项。每个对象定义一种身份验证类型。

该对象必须包括：

• ：凭证名称。必须与凭证文件中的属性匹配。例如，在指向的链接中。
• ：布尔值。指定使用此节点是否需要身份验证。

requestDefaults#

对象|必填

设置节点进行的 API 调用的基本信息。

该对象必须包括：

• ：API 基本 URL。

您还可以添加：

• ：描述 API 调用标头的对象，例如内容类型。
• ：字符串。附加到。通常可以省略此部分。更常见的做法是在 中提供此部分。

properties#

对象数组|必需

这包含定义节点行为的资源和操作对象，以及设置可以接收用户输入的强制和可选字段的对象。

资源对象

一个资源对象包含以下参数：

• ：字符串。这应该始终是。
• ：字符串。这应该始终是。
• ：字符串。告知 n8n 要使用哪个 UI 元素以及预期的输入类型。例如， n8n 会添加一个下拉菜单，允许用户选择一个选项。有关更多信息，请参阅Node UI 元素。
• ：布尔值。防止使用表达式作为参数。必须始终为for 。

操作对象

操作对象定义资源上可用的操作。

• ：字符串。这应该始终是。
• ：字符串。这应该始终是。
• ：字符串。指示 n8n 使用哪个 UI 元素以及预期的输入类型。例如，结果为 n8n 添加一个日期选择器。有关更多信息，请参阅Node UI 元素。
• ：布尔值。防止使用表达式作为参数。必须始终为for 。
• ：对象数组。每个对象描述操作的行为，例如其路由、使用的 REST 动词等等。一个对象包含：
  • . 字符串.
  • . 字符串.
  • ：字符串。此参数组合了资源和操作。您应该始终包含它，因为 n8n 会在未来版本中使用它。例如，给定一个名为 的资源
  • 和一个操作
  • ，您的操作就是
  • .
  • ：字符串.
  • ：包含请求详细信息的对象。

附加字段对象

这些对象定义了可选参数。n8n在 GUI 的“附加字段”下显示这些参数。用户可以选择要设置的参数。

这些对象必须包括：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

displayName: 'Additional Fields',
name: 'additionalFields',
// The UI element type
type: ''
placeholder: 'Add Field',
default: {},
displayOptions: {
  // Set which resources and operations this field is available for
  show: {
    resource: [
      // Resource names
    ],
    operation: [
      // Operation names
    ]
  },
}

有关 UI 元素类型的更多信息，请参阅UI 元素。