标准参数
以下是节点基础文件的标准参数,适用于所有节点类型。
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,分辨率应为 60×60 像素。节点图标的宽高比应为正方形或接近正方形。
不要直接引用 Font Awesome
如果希望在节点中使用 Font Awesome 图标,请下载图片并嵌入。不要设置 defaults.color:它仅用于为 Font Awesome 图标着色,n8n 3.0 会将其移除。
group
字符串数组 | 必填
告诉 n8n 节点在工作流运行时如何行动。可选值:
trigger:节点等待触发。schedule:节点等待计时结束。input、output、transform:目前没有作用。- 空数组
[]:如果不需要trigger或schedule,请将其用作默认选项。
description
字符串 | 必填
节点的简短描述,供 n8n 在图形界面中使用。
defaults
对象 | 必填
包含基本的品牌和名称设置。
此对象可包含:
name:字符串。如果displayName太长,则将此值用作画布上的节点名称。color:字符串。自 n8n 1.52.0 起弃用,并在 n8n 3.0 中移除。此字段仅用于为 Font Awesome 图标着色。请改用文件形式的图标。
forceInputNodeExecution
布尔值 | 可选
构建多输入节点时,可以选择在该节点运行前,强制执行所有分支上的全部上游节点。默认值为 false,即只要求其中一个输入分支运行。
inputs
字符串数组 | 必填
为输入连接器命名,并控制节点输入侧的连接器数量。如果只需要一个连接器,请使用 inputs: [NodeConnectionTypes.Main]。
outputs
字符串数组 | 必填
为输出连接器命名,并控制节点输出侧的连接器数量。如果只需要一个连接器,请使用 outputs: [NodeConnectionTypes.Main]。
requiredInputs
整数 或 数组 | 可选
用于多输入节点。按编号指定哪些输入必须有数据(对应分支必须运行),节点才能执行。
credentials
对象数组 | 必填
此参数指定 n8n 的凭据选项,每个对象定义一种身份验证类型。
此对象必须包含:
name:凭据名称,必须与凭据文件中的name属性匹配。例如,name: 'asanaApi'(位于Asana.node.ts)对应name = 'asanaApi'(位于AsanaApi.credential.ts)。required:布尔值,指定使用此节点是否需要身份验证。
requestDefaults
对象 | 必填
设置节点调用 API 时的基本信息。
此对象必须包含:
baseURL:API 的基础 URL。
还可以添加:
headers:描述 API 调用请求头的对象,例如内容类型。url:字符串,附加在baseURL之后。通常可以省略,更常见的做法是在operations中提供此值。
properties
对象数组 | 必填
包含定义节点行为的资源对象和操作对象,以及用于配置必填和可选用户输入字段的对象。