Skip to content

声明式参数#

这些是声明式节点的节点基础文件可用的参数。

本文档提供简短的代码片段来帮助理解代码结构和概念。有关构建节点的完整演练，包括真实世界的代码示例，请参考构建声明式节点。

参考标准参数了解所有节点可用的参数。

methods 和 loadOptions#

对象 | 可选

methods 包含 loadOptions 对象。您可以使用 loadOptions 查询服务以获取用户特定的设置，然后返回它们并在 GUI 中渲染，以便用户可以在后续查询中包含它们。该对象必须包含如何查询服务的路由信息，以及定义如何处理返回选项的输出设置。例如：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
methods : {
	loadOptions: {
		routing: {
			request: {
				url: '/webhook/example-option-parameters',
				method: 'GET',
			},
			output: {
				postReceive: [
					{
						// 当返回的数据嵌套在另一个属性下时
						// 指定该属性键
						type: 'rootProperty',
						properties: {
							property: 'responseData',
						},
					},
					{
						type: 'setKeyValue',
						properties: {
							name: '={{$responseItem.key}} ({{$responseItem.value}})',
							value: '={{$responseItem.value}}',
						},
					},
					{
						// 如果传入数据是对象数组，按键字母顺序排序
						type: 'sort',
						properties: {
							key: 'name',
						},
					},
				],
			},
		},
	}
},

routing#

对象 | 必需

routing 是在操作和输入字段对象的 options 数组中使用的对象。它包含 API 调用的详细信息。

下面的代码示例来自声明式教程。它设置了与 NASA API 的集成。它展示了如何使用 requestDefaults 设置基本的 API 调用详细信息，以及使用 routing 为每个操作添加信息。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
description: INodeTypeDescription = {
  // 其他节点信息在这里
  requestDefaults: {
			baseURL: 'https://api.nasa.gov',
			url: '',
			headers: {
				Accept: 'application/json',
				'Content-Type': 'application/json',
			},
		},
    properties: [
      // 资源在这里
      {
        displayName: 'Operation'
        // 其他操作详细信息
        options: [
          {
            name: 'Get'
            value: 'get',
            description: '',
            routing: {
              request: {
                method: 'GET',
                url: '/planetary/apod'
              }
            }
          }
        ]
      }
    ]
}

version#

数字 或 数组 | 可选

如果您的节点只有一个版本，这可以是一个数字。如果您想支持多个版本，请将其转换为数组，包含每个节点版本的数字。

n8n 支持两种节点版本控制方法，但声明式节点必须使用轻量级版本控制方法。参考节点版本控制了解更多信息。