跳到主要内容

声明式参数

以下参数适用于声明式节点的节点基础文件。

本文通过简短代码片段介绍代码结构和概念。包含实际代码示例的完整节点构建教程,请参阅构建声明式节点。

适用于所有节点的参数,请参阅标准参数。

methods 与 loadOptions ​

对象 | 可选

methods 包含 loadOptions 对象。你可以使用 loadOptions 查询服务,获取用户专属设置,再返回这些设置并显示在图形界面中,供用户在后续查询中选用。此对象必须包含查询服务的路由信息,以及定义如何处理返回选项的输出设置。例如:

methods : {
loadOptions: {
routing: {
request: {
url: '/webhook/example-option-parameters',
method: 'GET',
},
output: {
postReceive: [
{
// When the returned data is nested under another property
// Specify that property key
type: 'rootProperty',
properties: {
property: 'responseData',
},
},
{
type: 'setKeyValue',
properties: {
name: '={{$responseItem.key}} ({{$responseItem.value}})',
value: '={{$responseItem.value}}',
},
},
{
// If incoming data is an array of objects, sort alphabetically by key
type: 'sort',
properties: {
key: 'name',
},
},
],
},
},
}
},

routing ​

对象 | 必填

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

以下代码示例来自声明式节点教程,演示如何集成 NASA API,以及如何使用 requestDefaults 设置 API 调用的基本信息,再使用 routing 为每项操作添加信息。

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 ​

数字 或 数组 | 可选

如果节点只有一个版本,可以使用数字。如果要支持多个版本,请改用数组,并在其中填写每个节点版本的编号。

n8n 支持两种节点版本控制方式,但声明式节点必须使用轻量版本控制。更多信息请参阅节点版本控制。

features ​

对象 | 可选

定义具名功能标志,并根据节点版本进行判断。可以使用 @feature 在 displayOptions 中控制参数是否显示。

更多信息请参阅基于功能的版本控制。

相关资源 ​

本文为社区中文翻译。查看对应英文原文