声明式参数

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

本文档提供简短的代码片段帮助理解代码结构和概念。如需完整的节点构建指南（包含实际代码示例），请参阅构建声明式节点。

所有节点通用的参数请参考标准参数。

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 支持两种节点版本控制方法，但声明式节点必须使用轻量级版本控制方案。更多信息请参考节点版本控制。