标准参数

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

displayName

字符串 | 必需

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

name

字符串 | 必需

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

icon

字符串 或 对象 | 必需

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

您可以将图标文件名作为字符串提供，或作为对象来处理明暗模式的不同图标。 如果图标在明暗模式下都有效，请使用以 file: 开头的字符串，指示图标文件的路径。例如：

icon: 'file:exampleNodeIcon.svg'

要为明暗模式提供不同的图标，请使用具有 light 和 dark 属性的对象。例如：

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

n8n 建议为您的节点图标使用 SVG 格式，但您也可以使用 PNG。如果使用 PNG，图标分辨率应为 60x60px。节点图标应具有正方形或接近正方形的宽高比。

不要引用 Font Awesome

如果您想在节点中使用 Font Awesome 图标，请下载并嵌入图像。

group

字符串数组 | 必需

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

• trigger：节点等待触发器。
• schedule：节点等待计时器到期。
• input、output、transform：这些目前没有效果。
• 空数组 []。如果您不需要 trigger 或 schedule，请将此作为默认选项。

description

字符串 | 必需

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

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 添加一个允许用户选择一个选项的下拉菜单。有关更多信息，请参阅节点 UI 元素。
• noDataExpression：布尔值。防止对参数使用表达式。对于 resource 必须始终为 true。

操作对象

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

• displayName：字符串。这应该始终是 Options。
• name：字符串。这应该始终是 option。
• type：字符串。告诉 n8n 使用哪个 UI 元素，以及期望什么输入类型。例如，dateTime 导致 n8n 添加日期选择器。有关更多信息，请参阅节点 UI 元素。
• noDataExpression：布尔值。防止对参数使用表达式。对于 operation 必须始终为 true。
• options：对象数组。每个对象描述操作的行为，如其路由、使用的 REST 动词等。options 对象包括：
  • name：字符串。
  • value：字符串。
  • action：字符串。此参数结合资源和操作。您应该始终包含它，因为 n8n 将在未来版本中使用它。例如，给定名为 "Card" 的资源和 "Get all" 操作，您的 action 是 "Get all cards"。
  • description：字符串。
  • routing：包含请求详细信息的对象。

附加字段对象

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

对象必须包括：

displayName: 'Additional Fields',
name: 'additionalFields',
// UI 元素类型
type: ''
placeholder: 'Add Field',
default: {},
displayOptions: {
  // 设置此字段可用于哪些资源和操作
  show: {
    resource: [
      // 资源名称
    ],
    operation: [
      // 操作名称
    ]
  },
}

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