跳到主要内容

标准参数#

这些是节点基础文件的标准参数，适用于所有节点类型。

displayName#​

字符串类型 | 必需参数

用户在 n8n 图形界面中看到的显示名称。

name#​

字符串类型 | 必需参数

对象的内部名称，用于在节点其他位置引用该对象。

icon#​

字符串或对象类型 | 必需参数

为特定节点指定图标。n8n 推荐上传自定义图像文件。

可将图标文件名以字符串形式提供，或通过对象形式分别处理明暗模式下的图标。 若图标同时适用于明暗模式，请使用以 file: 开头的字符串指定图标文件路径。例如：

icon: 'file:exampleNodeIcon.svg'

要为浅色和深色模式提供不同图标，请使用包含 light 和 dark 属性的对象。例如：

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

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

请勿引用 Font Awesome 如需在节点中使用 Font Awesome 图标，请下载并嵌入图像文件。

group#​

字符串数组 | 必需

定义工作流运行时节点的行为模式。可选值包括：

  • trigger：节点等待触发器激活
  • schedule：节点等待定时器到期
  • input、output、transform：当前版本中暂未生效
  • 空数组 []：若无需 trigger 或 schedule 功能时作为默认选项

description#​

字符串 | 必需

节点的简短描述。n8n 将在图形界面中显示此描述。

defaults#​

对象 | 必需

包含核心品牌标识与名称设置。

该对象可包含：

  • name：字符串。当 displayName 过长时，作为画布上的节点名称显示
  • color：字符串。十六进制颜色代码。提供集成服务的品牌色供 n8n 使用

forceInputNodeExecution#​

布尔值 | 可选

构建多输入节点时，可强制要求所有分支上的前置节点均执行完毕后才运行当前节点。默认值为 false（仅需一个输入分支运行即可）。

inputs#​

字符串数组 | 必需

定义输入连接器名称。控制节点输入侧的连接器数量。若仅需单个连接器，请使用 input: ['main']。

outputs#​

字符串数组 | 必需

定义输出连接器名称。控制节点输出侧的连接器数量。若仅需单个连接器，请使用 output: ['main']。

requiredInputs#​

整数 或 数组 | 可选

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

credentials#​

对象数组 | 必需

定义认证配置选项。每个对象描述一种认证类型。

对象必须包含：

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

requestDefaults#​

对象 | 必需

配置节点发起 API 调用的基础信息。

该对象必须包含：

  • baseURL：API 基础地址

还可添加：

  • headers：描述 API 调用头部的对象，如内容类型
  • url：字符串。附加到 baseURL 之后。通常可省略此参数，更常见的做法是在 operations 中提供

properties#​

对象数组 | 必需

包含定义节点行为的资源与操作对象，以及配置可接收用户输入的必选/可选字段的对象。

资源对象#​

资源对象包含以下参数：

  • displayName：字符串。固定值为 Resource
  • name：字符串。固定值为 resource
  • type：字符串。指示 n8n 使用的 UI 元素及输入类型。例如 options 会生成下拉选择框。详见节点 UI 元素
  • noDataExpression：布尔值。禁止对参数使用表达式。对于 resource 必须始终为 true

操作对象#​

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

  • displayName：字符串。固定值为 Options
  • name：字符串。固定值为 option
  • type：字符串。指示 n8n 使用的 UI 元素及输入类型。例如 dateTime 会生成日期选择器。详见节点 UI 元素
  • noDataExpression：布尔值。禁止对参数使用表达式。对于 operation 必须始终为 true
  • options：对象数组。每个对象描述操作的行为特征，如路由配置、使用的 REST 动词等。options 对象包含：
    • name：字符串
    • value：字符串
    • action：字符串。该参数组合资源与操作名称。建议始终包含，n8n 将在未来版本中使用。例如资源名为 "Card"、操作为 "Get all" 时，操作动作应设为 "Get all cards"
    • description：字符串
    • routing：包含请求详细配置的对象

附加字段对象#​

这些对象定义可选参数。n8n 会在图形界面的「附加字段」区域显示这些参数，用户可自主选择需要设置的参数。

对象必须包含：

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