API 连接器构建器
当任务是为仓库添加一个原生集成的接口,而不仅仅是创建一个通用的HTTP客户端时,请使用此技能。
关键在于匹配宿主仓库的模式:
- 连接器布局
- 配置模式
- 认证模型
- 错误处理
- 测试风格
- 注册/发现连接机制
使用场景
- "为此项目构建一个Jira连接器"
- "按照现有模式添加一个Slack提供者"
- "为此API创建一个新的集成"
- "构建一个符合仓库连接器风格的插件"
约束规则
- 如果仓库已有集成架构,不要发明新的架构
- 不要仅从供应商文档开始;先查阅仓库中现有的连接器
- 如果仓库需要注册连接、测试和文档,就不要仅停留在传输代码层面
- 如果仓库有更新的当前模式,不要盲目复制旧的连接器
工作流程
1. 学习家规
检查至少两个现有的连接器/提供者,并映射:
- 文件布局
- 抽象边界
- 配置模型
- 重试/分页约定
- 注册钩子
- 测试固定装置和命名
2. 缩小目标集成范围
仅定义仓库真正需要的接口:
- 认证流程
- 关键实体
- 核心读/写操作
- 分页和速率限制
- Webhook或轮询模型
3. 在仓库本地层中构建
典型层次:
- 配置/模式
- 客户端/传输
- 映射层
- 连接器/提供者入口点
- 注册
- 测试
4. 根据源模式进行验证
新连接器在代码库中应显得自然而然,而不是从不同的生态系统中导入的。
参考结构
提供者风格
providers/
existing_provider/
__init__.py
provider.py
config.py
连接器风格
integrations/
existing/
client.py
models.py
connector.py
TypeScript 插件风格
src/integrations/
existing/
index.ts
client.ts
types.ts
test.ts
质量检查清单
- 匹配仓库中现有的集成模式
- 存在配置验证
- 认证和错误处理是明确的
- 分页/重试行为遵循仓库规范
- 注册/发现连接完整
- 测试反映宿主仓库的风格
- 如果仓库期望,则更新了文档/示例
相关技能
backend-patternsmcp-server-patternsgithub-ops