Api Connector Builder

affaan-m/ECC/skills/api-connector-builder

作者 affaan-mef648e01899ba3e8dc6371642deaaf64b4477775無授權條款275K 個星標收錄於 2026年10月9日更新於 2026年10月9日儲存庫4 天前更新

Build a new API connector or provider by matching the target repo's existing integration pattern exactly. Use when adding one more integration without inventing a second architecture.

AI 產生的概覽

指導建立與現有儲存庫整合模式一致的新 API 連接器或提供者。

功能
此技能提供一套工作流程,用於加入儲存庫原生的 API 整合,而非通用 HTTP 用戶端。內容包括:檢視現有連接器以了解既有風格、縮小目標整合範圍、依儲存庫原生分層進行建置,並對照來源模式進行驗證。也包含防護規則、參考目錄結構與品質檢查清單。
適用情境
適用於在已有既定整合模式的程式碼庫中加入新的連接器、提供者或整合。適合諸如建立遵循現有慣例的 Jira 連接器或 Slack 提供者之類的需求。
執行需求
無需指令碼或特殊工具,僅為說明性指示。需要能存取目標儲存庫,以便檢視現有連接器。

API Connector Builder

Use this when the job is to add a repo-native integration surface, not just a generic HTTP client.

The point is to match the host repository's pattern:

  • connector layout
  • config schema
  • auth model
  • error handling
  • test style
  • registration/discovery wiring

When to Use

  • "Build a Jira connector for this project"
  • "Add a Slack provider following the existing pattern"
  • "Create a new integration for this API"
  • "Build a plugin that matches the repo's connector style"

Guardrails

  • do not invent a new integration architecture when the repo already has one
  • do not start from vendor docs alone; start from existing in-repo connectors first
  • do not stop at transport code if the repo expects registry wiring, tests, and docs
  • do not cargo-cult old connectors if the repo has a newer current pattern

Workflow

1. Learn the house style

Inspect at least 2 existing connectors/providers and map:

  • file layout
  • abstraction boundaries
  • config model
  • retry / pagination conventions
  • registry hooks
  • test fixtures and naming

2. Narrow the target integration

Define only the surface the repo actually needs:

  • auth flow
  • key entities
  • core read/write operations
  • pagination and rate limits
  • webhook or polling model

3. Build in repo-native layers

Typical slices:

  • config/schema
  • client/transport
  • mapping layer
  • connector/provider entrypoint
  • registration
  • tests

4. Validate against the source pattern

The new connector should look obvious in the codebase, not imported from a different ecosystem.

Reference Shapes

Provider-style

text
providers/  existing_provider/    __init__.py    provider.py    config.py

Connector-style

text
integrations/  existing/    client.py    models.py    connector.py

TypeScript plugin-style

text
src/integrations/  existing/    index.ts    client.ts    types.ts    test.ts

Quality Checklist

  • matches an existing in-repo integration pattern
  • config validation exists
  • auth and error handling are explicit
  • pagination/retry behavior follows repo norms
  • registry/discovery wiring is complete
  • tests mirror the host repo's style
  • docs/examples are updated if expected by the repo

Related Skills

  • backend-patterns
  • mcp-server-patterns
  • github-ops

來源與署名

來源:affaan-m/ECC位於skills/api-connector-builder提交ef648e0

授權條款: 無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架