节点添加

工程开发 社区

技能解读

当前原文的自动摘译,尚未人工审校。

概述

向现有 n8n 节点添加 OAuth2(授权代码/3LO)支持。适用于任何支持标准 OAuth2 的第三方服务。在开始之前,请阅读packages/nodes-base/credentials/下的类似现有 OAuth2 凭证文件和测试,以了解此代码库中使用的约定(例如DiscordOAuth2Api.credentials.ts、MicrosoftTeamsOAuth2Api.credentials.ts)。

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
工程开发
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@n8n-io · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
需手动接入
是否需要外部接口密钥
需要 · Vendor-specific
兼容的系统
macOS · Linux · Windows
运行环境要求
Node.js
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
  • 命令执行
网络行为
允许外网请求
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

01
步骤 0 — 解析参数

摘录:`NODE_NAME`:服务名称(例如`GitHub`、`Notion`)。尝试从论证中推断;如果有歧义,请询问用户。 `CUSTOM_SCOPES`:凭证是否应支持用户定义的范围。如果参数没有明确说明这一点,请在继续之前询问用户:

02
第 1 步 - 探索节点

阅读以下内容(调整特定服务的路径约定): 节点目录:`packages/nodes-base/nodes/{NODE_NAME}/` 查找`*.node.ts`(主节点)和任何`*Trigger.node.ts` 查找`GenericFunctions.ts`(可能有不同的命名) 检查`auth` / `version` 子目录是否存在

03
第 2 步 — 研究 OAuth2 端点

查找服务的 OAuth2 文档: 授权 URL 访问令牌 URL 所需的身份验证查询参数(例如 `prompt=consent`、`access_type=offline`) 节点现有操作所需的默认范围

04
第 3 步 — 创建凭证文件

文件:`packages/nodes-base/credentials/{NODE_NAME}OAuth2Api.credentials.ts` 规则:无 `authenticate` 区块 — `oAuth2Api` 机器自动处理不记名令牌注入。没有`test`块——OAuth舞蹈验证凭证。模块级别的`defaultScopes`是唯一的事实来源:它填充了

05
步骤 4 — 在 package.json 中注册凭证

文件:`packages/nodes-base/package.json` 找到`n8n.credentials` 数组并在该服务的其他凭证附近插入新条目(在服务块内按字母顺序排列):

06
步骤 5 — 更新 GENERICOAUTH2CREDENTIALSWITHEDITABLESCOPE(仅限自定义范围)

仅当 CUSTOM_SCOPES = yes 时才执行此步骤。文件:`packages/cli/src/constants.ts`将`'{camelCase}OAuth2Api'`添加到`GENERIC_OAUTH2_CREDENTIALS_WITH_EDITABLE_SCOPE`数组。如果没有这个,n8n 会在 OAuth2 重新连接时删除用户的自定义范围。

07
第 8 步 — 编写证书测试

文件:`packages/nodes-base/credentials/test/{NODE_NAME}OAuth2Api.credentials.test.ts`使用`@n8n/client-oauth2`和`nock`中的`ClientOAuth2`进行HTTP模拟。遵循`MicrosoftTeamsOAuth2Api.credentials.test.ts`中的结构。所需的测试用例:元数据 - 名称、扩展数组、`enabledScopes` 默认值、身份验证 URL、令牌 URL、

08
步骤 9 — 更新 GenericFunctions.test.ts

在凭证路由 `describe` 块中:如果添加了站点 ID 缓存 (`_cloudIdCache`),请将其导入并在 `afterEach` 中调用 `_cloudIdCache.clear()`(或等效项)。添加/更新 OAuth2 路由测试用例:简单路由:使用正确的凭据调用断言`getCredentials`

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。