n8n 中文文档

节点文件结构

在节点结构中遵循最佳实践和标准使您的节点更易于维护。如果其他人需要使用代码,这会很有帮助。

您节点的文件和目录结构取决于:

  • 您节点的复杂性。
  • 是否使用节点版本控制。
  • 您在 npm 包中包含多少个节点。

n8n 建议使用 n8n-node 工具 创建预期的节点文件结构。您可以根据需要自定义生成的脚手架,以满足更复杂的需求。

所需文件和目录

您的节点必须包括:

  • 项目根目录下的 package.json 文件。每个 npm 模块都需要这个。
  • nodes 目录,包含节点的代码:
    • 此目录必须包含 基本文件,格式为 <node-name>.node.ts。例如,MyNode.node.ts。
    • n8n 建议包含一个 codex 文件,其中包含节点的元数据。 Codex 文件名必须与节点基本文件名匹配。例如,给定一个名为 MyNode.node.ts 的节点基础文件,则代码名称为 MyNode.node.json。
    • nodes 目录可以包含其他文件和子目录,包括版本目录,以及跨多个文件分割的节点代码以创建模块化结构。
  • credentials 目录,包含您的凭据代码。此代码位于单个凭据文件中。文件名格式为 <node-name>.credentials.ts。例如,MyNode.credentials.ts。

模块化结构

您可以选择是将节点的所有功能放在一个文件中,还是将其拆分为一个基本文件和其他模块,然后由基本文件导入这些模块。除非您的节点非常简单,否则最好将其拆分。

基本模式是分离操作。有关此示例,请参考 GithubIssues 启动器节点{:target=_blank .external-link}。

对于更复杂的节点,n8n 建议使用目录结构。请参考 Airtable 节点{:target=_blank .external-class}或 Microsoft Outlook 节点{:target=_blank .external-link}作为示例。

  • actions:包含代表资源的子目录的目录。
    • 每个子目录应包含两种类型的文件:
    • 带有资源描述的索引文件(命名为 <resourceName>.resource.ts 或 index.ts)
    • 操作文件 <operationName>.operation.ts。这些文件应包含两个导出:操作的 description 和一个 execute 函数。
  • methods:可选目录动态参数功能。
  • transport:包含通信实现的目录。

版本控制

如果您的节点有多个版本,并且您使用的是完整版本控制,这会使文件结构更加复杂。每个版本都需要一个目录,以及设置默认版本的基本文件。有关使用版本(包括版本控制类型)的更多信息,请参阅 Node 版本控制。

确定一个包中包含的节点数量

构建节点时有两种可能的设置:

  • 一个 npm 包中的一个节点。
  • 单个 npm 包中有多个节点。

n8n 支持这两种方法。如果包含多个节点,则每个节点都应在 nodes 目录中拥有自己的目录。

编程节点的最佳实践示例

n8n 的内置 Airtable 节点 实现了模块化结构和版本控制,遵循推荐模式。

相关资源

不想自己部署和维护 n8n?n8ncn 托管 n8n 云服务:开通账号即可使用,不用买服务器;也可以在 n8ncn 工作流库 找现成的中文工作流。