声明式参数
这些是声明式节点的节点基础文件可用的参数。
本文档提供了简短的代码片段,以帮助理解代码结构和概念。有关构建节点的完整演练,包括实际代码示例,请参阅构建声明式样式节点。
所有节点可用的参数请参考标准参数。
methods 和 loadOptions
对象 | 可选
methods 包含 loadOptions 对象。您可以使用 loadOptions 查询服务以获取用户特定的设置,然后返回它们并在 GUI 中渲染,以便用户可以在后续查询中包含它们。该对象必须包含如何查询服务的路由信息,以及定义如何处理返回选项的输出设置。例如:
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 添加每个操作的信息。
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 支持两种节点版本控制方法,但声明式节点必须使用轻型版本控制方法。有关更多信息,请参阅 Node 版本控制。
features
对象 | 可选
定义根据节点版本评估的命名功能标志。使用 displayOptions 中的 @feature 功能来控制参数可见性。
有关更多信息,请参阅基于功能的版本控制。
相关资源
不想自己部署和维护 n8n?n8ncn 托管 n8n 云服务:开通账号即可使用,不用买服务器;也可以在 n8ncn 工作流库 找现成的中文工作流。