API 連接器建構器 是做什麼的?
當任務是加入一個符合儲存庫原生模式的整合層,而不僅是泛用的 HTTP 客戶端時,請使用此技能。
關鍵在於符合宿主儲存庫的模式:
- 連接器佈局
- 設定架構
- 驗證模型
- 錯誤處理
- 測試風格
- 註冊/探索接線
使用時機
- "為此專案建構一個 Jira 連接器"
- "依照現有模式加入一個 Slack 提供者"
- "為此 API 建立一個新的整合"
- "建構一個符合儲存庫連接器風格的插件"
保護措施
- 若儲存庫已有整合架構,不要發明新的架構
- 不要只從廠商文件開始;應先從儲存庫內既有的連接器著手
- 若儲存庫預期要加入註冊接線、測試及文件,不要只停在傳輸層程式碼
- 若儲存庫有更新的現行模式,不要盲目照搬舊的連接器
工作流程
1. 學習內部風格
檢查至少 2 個既有的連接器/提供者,並記錄:
- 檔案佈局
- 抽象層邊界
- 設定模型
- 重試/分頁慣例
- 註冊鉤子
- 測試 fixture 與命名
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