标准参数#

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

displayName#

字符串 | 必填

这是用户在n8n图形界面中看到的名称。

name#

字符串 | 必填

对象的内部名称。用于从节点的其他位置引用它。

icon#

字符串 或 对象 | 必填

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

您可以提供图标文件名作为字符串，或作为对象来处理浅色和深色模式下的不同图标。 如果图标在浅色和深色模式下都适用，请使用以file:开头的字符串，表示图标文件的路径。例如：

1

icon: 'file:exampleNodeIcon.svg'

1
2
3
4

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

n8n推荐使用SVG格式作为节点图标，但您也可以使用PNG。如果选择PNG格式，图标分辨率应为60x60像素。节点图标的长宽比应保持正方形或接近正方形。

group#

字符串数组 | 必填

告诉n8n当工作流运行时节点如何表现。选项有：

• trigger: 节点等待触发。
• schedule: 节点等待计时器到期。
• input, output, transform: 这些参数当前没有实际作用。
• 一个空数组，[]。如果不需要trigger或schedule，请将此作为默认选项。

description#

字符串 | 必填

节点的简短描述。n8n在图形界面中使用此描述。

defaults#

对象 | 必填

包含基本的品牌和名称设置。

该对象可以包含：

• name: 字符串。当displayName过长时，用作画布上的节点名称。
• color: 字符串。十六进制颜色代码。提供集成的品牌颜色以便在n8n中使用。

forceInputNodeExecution#

布尔值 | 可选

在构建多输入节点时，您可以选择强制所有分支上的前置节点在该节点运行前执行。默认值为false（仅需一个输入分支运行即可）。

inputs#

字符串数组 | 必填

命名输入连接器。控制节点在输入侧拥有的连接器数量。如果只需要一个连接器，请使用 input: ['main']。

outputs#

字符串数组 | 必填

命名输出连接器。控制节点在输出端拥有的连接器数量。如果只需要一个连接器，请使用output: ['main']。

requiredInputs#

整数 或 数组 | 可选

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

credentials#

对象数组 | 必填

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

该对象必须包含：

• name: 凭证名称。必须与凭证文件中的name属性匹配。例如，Asana.node.ts中的name: 'asanaApi'对应AsanaApi.credential.ts中的name = 'asanaApi'。
• required: 布尔值。指定使用此节点是否需要身份验证。

requestDefaults#

对象 | 必填

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

该对象必须包含：

• baseURL: API基础URL。

您还可以添加：

• headers: 一个描述API调用头信息的对象，例如内容类型。
• url: 字符串。附加到baseURL上。通常可以省略此项，更常见的做法是在operations中提供。

properties#

对象数组 | 必填

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

资源对象#

资源对象包含以下参数：

• displayName: 字符串。该值应始终为Resource。
• name: 字符串。该值应始终为resource。
• type: 字符串。告知n8n使用哪个UI元素以及预期的输入类型。例如，options会导致n8n添加一个下拉菜单，允许用户选择一个选项。更多信息请参考Node UI elements。
• noDataExpression: 布尔值。阻止为该参数使用表达式。对于resource必须始终为true。

操作对象#

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

• displayName: 字符串。该值应始终为Options。
• name: 字符串。该值应始终为option。
• type: 字符串类型。告知n8n使用哪个UI元素以及预期的输入类型。例如，dateTime会使n8n添加日期选择器。更多信息请参阅Node UI elements。
• noDataExpression: 布尔值。阻止为该参数使用表达式。对于operation必须始终为true。
• options: Array of objects. Each objects describes an operation's behavior, such as its routing, the REST verb it uses, and so on. An options object includes:
  • name. 字符串类型。
  • value. 字符串类型。
  • action: 字符串类型。此参数结合了资源和操作。您应始终包含它，因为n8n将在未来版本中使用它。例如，给定一个名为"Card"的资源和一个"Get all"操作，您的action就是"Get all cards"。
  • description: 字符串。
  • routing: 包含请求详细信息的对象。

附加字段对象#

这些对象定义了可选参数。n8n在图形界面的附加字段下显示它们。用户可以选择要设置的参数。

对象必须包含：

 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元素。