
n8n-nodes-starter
克隆即写自定义 n8n 节点,快速接入任意 API
n8n-nodes-starter 是 n8n 官方提供的自定义节点开发模板,面向希望扩展 n8n 自动化能力的开发者。n8n 本身是一个开源工作流自动化工具,内置节点有限,当需要对接私有 API、内部系统或小众服务时,就需要自行编写节点。本项目提供了一套开箱即用的 TypeScript 工程骨架,包含节点定义、凭证配置、构建脚本、测试与发布流程的标准结构,解决从零搭建节点项目繁琐、容易遗漏配置的问题。核心能力包括:标准化节点与凭证类结构、基于 TypeScript 的类型提示、可运行的示例节点、npm 打包与 n8n 社区节点发布所需的基础配置。开发者克隆后即可专注于业务逻辑,快速产出可安装到 n8n 的自定义节点,适合集成企业内网服务或第三方平台。
项目数据
使用教程
环境要求
- Node.js 与 npm 环境(npm install / npm run 均依赖)
- 本地可运行的 n8n 环境,用于加载开发中的节点
- 了解 TypeScript 基础,便于读懂示例节点
- 发布到 npm 需准备 npm 账号与 GitHub 仓库
安装与启动步骤
-
1创建节点包
README 推荐的最快起步方式,用官方脚手架生成完整的节点包工程结构。
npm create @n8n/node -
2安装依赖
在项目根目录执行,会安装全部依赖,包含 n8n 官方节点开发 CLI。
npm install -
3启动开发调试
以开发模式启动 n8n 并加载你写的节点,开启热重载,改代码即时生效。
npm run dev -
4阅读示例节点
参考 Example 节点的基础 execute 写法,以及 GithubIssues 的声明式低代码写法。
-
5配置 npm 发布
登录 npmjs.com 进入包设置,在 Publish access 的 Trusted Publishers 添加发布者。
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
Repository owner | 是 | Trusted Publisher 中填写的 GitHub 用户名或组织名 | your-github-name |
Repository name | 是 | Trusted Publisher 中填写的仓库名称 | your-repo-name |
Workflow name | 是 | Trusted Publisher 中填写的工作流文件名 | publish.yml |
NPM_TOKEN | 否 | 不使用 OIDC 时,改为存放 npm 传统令牌的 Actions secret | npm_xxxxxxxxxxxx |
如何确认成功
执行 npm run dev 后 n8n 正常启动,并能看到自带节点已加载、修改代码可热重载。
常见问题
Q:新建节点包该用哪种方式?
A:README 推荐直接用 npm create @n8n/node,官方脚手架会生成完整节点包;已有本模板仓库则直接 npm install 后 npm run dev 开发。
Q:节点用哪种写法更好?
A:README 推荐声明式(low-code)风格,即 GithubIssues 示例的写法,无需手写请求逻辑,适合基于 HTTP API 的集成。
Q:发布必须配置 npm token 吗?
A:不必。可配置 Trusted Publishers 走 GitHub OIDC,GitHub 中无需保存任何 token;若偏好传统方式再创建 Granular Access Token 存为 NPM_TOKEN。
注意事项
- 仓库自带两个可运行示例:基础版 Example 与声明式版 GithubIssues,建议先照着改
- 声明式/低代码风格是官方推荐做法,适合 HTTP API 类集成
- 使用 OIDC 发布时无需在 GitHub 存放任何密钥,只需在 npm 端配置发布者信息
- 打包与社区节点发布所需的基础配置模板中已包含,无需从零搭建
核心亮点
- 官方维护,目录结构与 n8n 节点规范保持一致
- 内置 TypeScript 类型与示例节点,降低上手门槛
- 包含构建、测试与发布配置,可直接产出可安装的 npm 包
不足之处
- 仅为模板骨架,不含具体业务节点实现
- 功能更新跟随 n8n 主版本,需自行关注兼容性
适用场景
- 为企业内部系统开发专属 n8n 节点
- 对接 n8n 未内置的第三方 API 服务
- 学习 n8n 自定义节点开发规范与发布流程
替代项目
n8n、Activepieces、Node-RED
项目介绍
上一篇:n8n-hosting
下一篇:n8n-autoscaling
同类项目推荐
n8n
开源
拖拽搭建自动化流程,轻松接入 AI 与 400+ 应用,搞定重复工作。
Fair-code workflow automation platform with native AI capabilities. Combine visual b···
robotcode
开源
让 Robot Framework 拥有现代 IDE 体验,调试、补全、运行一气呵成。
Open Source Toolkit for Robot Framework, providing Language Server Protocol support,···
puppeteer
开源
用 JavaScript 轻松操控无头浏览器,搞定自动化测试与网页抓取。
JavaScript API for Chrome and Firefox
customermates
开源
比 Pipedrive 直观 10 倍的现代开源 CRM,轻松管理客户与自动化流程。
Building a modern alternative to Pipedrive that is 10x more intuitive.