n8n-nodes-demo-custom

这是一个 n8n 社区节点包，包含演示性的自定义节点，可以集成到 n8n 工作流中。

功能特性

本包提供以下节点：

1. Demo HTTP Request (演示 HTTP 请求)

• 执行 HTTP 请求 (GET, POST, PUT, DELETE)
• 支持自定义请求头和请求体
• 处理 JSON 响应数据

2. Demo Transform (演示数据转换)

• 支持多种数据转换操作：
  • 大写转换
  • 小写转换
  • 文本反转
  • 字符计数
  • 字符串分割

3. Demo Credentials (演示凭证)

• API 密钥管理
• API URL 配置

安装

方法 1: 从 npm 安装 (发布后)

npm install n8n-nodes-demo-custom

然后在 n8n 中重启使节点可用。

方法 2: 本地开发安装

# 克隆仓库
git clone https://github.com/yourusername/n8n-nodes-demo-custom
cd n8n-nodes-demo-custom

# 安装依赖
npm install

# 构建项目
npm run build

# 创建软链接到 n8n (可选)
npm link

使用

在 n8n 编辑器中：

1. 创建新的工作流
2. 添加节点 → 搜索 "Demo" → 选择所需的节点
3. 配置节点参数
4. 测试并运行工作流

开发

项目结构

.
├── src/
│   ├── nodes/              # 节点定义
│   │   ├── DemoHttp/
│   │   └── DemoTransform/
│   └── credentials/        # 凭证定义
├── dist/                   # 编译后的 JavaScript
├── package.json
├── tsconfig.json
└── README.md

命令

• npm run build - 编译 TypeScript
• npm run dev - 开发模式（监听文件变化）
• npm run lint - 代码检查
• npm run format - 代码格式化
• npm test - 运行测试

创建新节点

1. 在 src/nodes/ 中创建新目录
2. 创建 YourNode.node.ts 文件，继承 INodeType
3. 在 package.json 的 n8n.nodes 数组中添加节点路径
4. 编译并测试

发布到 npm

1. 准备工作

# 更新 package.json 中的基本信息
- name: "n8n-nodes-your-org-your-name"
- version: "0.1.0"
- description: 您的节点描述
- author: 您的名称和邮箱
- repository: 您的 GitHub 仓库链接

2. 构建项目

npm run build

3. 登录 npm

npm login
# 输入您的 npm 用户名、密码和邮箱

4. 发布到 npm

npm publish

5. 验证发布

npm view n8n-nodes-your-org-your-name

在 n8n 社区节点市场注册

发布到 npm 后，您需要在 n8n 社区节点市场中注册您的节点。

步骤：

1. 访问社区节点市场: https://n8n.io/community-nodes

2. 提交您的节点:

   • 填写表单提交您的节点信息
   • 提供 npm 包名称
   • 添加清晰的描述和文档
   • 提供演示截图或视频（可选）

3. 审核过程:

   • n8n 团队将审核您的节点
   • 检查代码质量和安全性
   • 验证 npm 包的完整性

4. 上线:

   • 审核通过后，您的节点将出现在社区节点市场
   • 用户可以搜索并安装您的节点

npm 包命名规范

为了在社区节点市场中被识别，npm 包名称应遵循以下格式：

n8n-nodes-<org-or-author>-<node-name>

示例:

• n8n-nodes-demo-custom - 演示项目
• n8n-nodes-stripe-integration - Stripe 集成节点
• n8n-nodes-slack-advanced - Slack 高级节点

文件要求

确保您的 npm 包包含：

• ✅ package.json - 包含 n8n.nodes 和 n8n.credentials 字段
• ✅ 编译后的 .js 文件在 dist/ 目录
• ✅ TypeScript 类型定义（.d.ts 文件）
• ✅ README.md - 完整的文档
• ✅ LICENSE - 许可证（推荐 MIT）

最佳实践

1. 代码质量

   • 使用 TypeScript
   • 编写清晰的注释
   • 遵循 n8n 编码规范

2. 文档

   • 在 displayName 中提供中文描述
   • 为每个参数提供说明
   • 在 README 中添加使用示例

3. 错误处理

   • 实现 continueOnFail() 支持
   • 提供有意义的错误消息

4. 测试

   • 编写单元测试
   • 测试各种输入场景

示例：查看已发布的社区节点

您可以在以下地方查看其他社区节点作为参考：

• n8n 社区节点市场
• n8n nodes 官方仓库

许可证

MIT

支持和贡献

• 报告问题: GitHub Issues
• 贡献代码: 提交 Pull Request
• 讨论: n8n 社区论坛

相关资源

• n8n 官方文档
• n8n 社区节点开发指南
• n8n GitHub