声明式参数#
这些是声明式节点节点基础文件可用的参数。 本文档提供简短的代码片段以帮助理解代码结构和概念。如需完整构建节点的实践指南(包含真实代码示例),请参阅构建声明式节点。 所有节点通用的参数请参阅标准参数。
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={ // Other node info here requestDefaults:{ baseURL:'https://api.nasa.gov', url:'', headers:{ Accept:'application/json', 'Content-Type':'application/json', }, }, properties:[ // Resources here { displayName:'Operation' // Other operation details options:[ { name:'Get' value:'get', description:'', routing:{ request:{ method:'GET', url:'/planetary/apod' } } } ] } ] }
---|---
## `version`[#](https://docs.n8n.io/integrations/creating-nodes/build/reference/node-base-files/declarative-style-parameters/#version "永久链接")
_数字_ 或 _数组_ | _可选参数_
如果节点只有一个版本,此参数可以是数字。如果需要支持多个版本,请将其转换为包含各节点版本号的数组。
n8n 支持两种节点版本控制方法,但声明式风格节点必须使用轻量级版本控制方案。更多信息请参阅[节点版本控制](https://docs.n8n.io/integrations/creating-nodes/build/reference/node-versioning/)。