选择您的节点构建方法

n8n 有两种节点构建样式：声明式和编程式。

您应该对大多数节点使用声明式样式。这种样式：

• 使用基于 JSON 的语法，使其更简单易写，引入错误的风险更小。
• 更具未来性。
• 支持与 REST API 的集成。

编程式样式更加冗长。您必须在以下情况下使用编程式样式：

• 触发器节点
• 任何非基于 REST 的节点。这包括需要调用 GraphQL API 的节点和使用外部依赖的节点。
• 任何需要转换传入数据的节点。
• 完整版本控制。有关版本控制类型的更多信息，请参阅节点版本控制。

数据处理差异

声明式和编程式样式之间的主要区别在于它们如何处理传入数据和构建 API 请求。编程式样式需要一个 execute() 方法，该方法读取传入数据和参数，然后构建请求。声明式样式使用 operations 对象中的 routing 键来处理这一点。有关节点参数和 execute() 方法的更多信息，请参阅节点基础文件。

语法差异

要了解声明式和编程式样式之间的区别，请比较下面的两个代码片段。此示例创建了 SendGrid 集成的简化版本，称为"FriendGrid"。以下代码片段并不完整：它们强调了节点构建样式的差异。

编程式样式：

import {
	IExecuteFunctions,
	INodeExecutionData,
	INodeType,
	INodeTypeDescription,
	IRequestOptions,
} from 'n8n-workflow';

// 创建 FriendGrid 类
export class FriendGrid implements INodeType {
  description: INodeTypeDescription = {
    displayName: 'FriendGrid',
    name: 'friendGrid',
    . . .
    properties: [
      {
        displayName: 'Resource',
        . . .
      },
      {
        displayName: 'Operation',
        name: 'operation',
        type: 'options',
        displayOptions: {
          show: {
              resource: [
              'contact',
              ],
          },
        },
        options: [
          {
            name: 'Create',
            value: 'create',
            description: 'Create a contact',
          },
        ],
        default: 'create',
        description: 'The operation to perform.',
      },
      {
        displayName: 'Email',
        name: 'email',
        . . .
      },
      {
        displayName: 'Additional Fields',
        // 设置可选字段
      },
    ],
};

  async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
    let responseData;
    const resource = this.getNodeParameter('resource', 0) as string;
    const operation = this.getNodeParameter('operation', 0) as string;
    //获取用户为此节点提供的凭据
    const credentials = await this.getCredentials('friendGridApi') as IDataObject;

    if (resource === 'contact') {
      if (operation === 'create') {
      // 获取电子邮件输入
      const email = this.getNodeParameter('email', 0) as string;
      // 获取附加字段输入
      const additionalFields = this.getNodeParameter('additionalFields', 0) as IDataObject;
      const data: IDataObject = {
          email,
      };

      Object.assign(data, additionalFields);

      // 按照 https://sendgrid.com/docs/api-reference/ 中定义的方式发出 HTTP 请求
      const options: IRequestOptions = {
        headers: {
            'Accept': 'application/json',
            'Authorization': `Bearer ${credentials.apiKey}`,
        },
        method: 'PUT',
        body: {
            contacts: [
            data,
            ],
        },
        url: `https://api.sendgrid.com/v3/marketing/contacts`,
        json: true,
      };
      responseData = await this.helpers.httpRequest(options);
      }
    }
    // 将数据映射到 n8n 数据
    return [this.helpers.returnJsonArray(responseData)];
  }
}

声明式样式：

import { INodeType, INodeTypeDescription } from 'n8n-workflow';

// 创建 FriendGrid 类
export class FriendGrid implements INodeType {
  description: INodeTypeDescription = {
    displayName: 'FriendGrid',
    name: 'friendGrid',
    . . .
    // 设置基本请求配置
    requestDefaults: {
      baseURL: 'https://api.sendgrid.com/v3/marketing'
    },
    properties: [
      {
        displayName: 'Resource',
        . . .
      },
      {
        displayName: 'Operation',
        name: 'operation',
        type: 'options',
        displayOptions: {
          show: {
            resource: [
              'contact',
            ],
          },
        },
        options: [
          {
            name: 'Create',
            value: 'create',
            description: 'Create a contact',
            // 添加路由对象
            routing: {
              request: {
                method: 'POST',
                url: '=/contacts',
                send: {
                  type: 'body',
                  properties: {
                    email: {{$parameter["email"]}}
                  }
                }
              }
            },
            // 处理联系人创建的响应
            output: {
              postReceive: [
                {
                  type: 'set',
                  properties: {
                    value: '={{ { "success": $response } }}'
                  }
                }
              ]
            }
          },
        ],
        default: 'create',
        description: 'The operation to perform.',
      },
      {
        displayName: 'Email',
        . . .
      },
      {
        displayName: 'Additional Fields',
        // 设置可选字段
      },
    ],
  }
  // 不需要 execute 方法
}