标准参数 #

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

`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`#

字符串数组 | 必填告诉 n8n 工作流运行时节点的行为方式。选项包括：

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

`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" 操作，操作应为 "Get all cards"
- description：字符串类型
- routing：包含请求详细信息的对象

附加字段对象 #

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

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


---|---
有关 UI 元素类型的更多信息，请参阅 [UI 元素](https://docs.n8n.io/integrations/creating-nodes/build/reference/ui-elements/)。