construtor-de-conector-api

Construtor de Conector de API

Use isto quando a tarefa é adicionar uma superfície de integração nativa ao repositório, não apenas um cliente HTTP genérico.

O objetivo é corresponder ao padrão do repositório anfitrião:

• layout do conector
• esquema de configuração
• modelo de autenticação
• tratamento de erros
• estilo de teste
• fiação de registro/descoberta

Quando Usar

• "Construa um conector Jira para este projeto"
• "Adicione um provedor Slack seguindo o padrão existente"
• "Crie uma nova integração para esta API"
• "Construa um plugin que corresponda ao estilo de conector do repositório"

Diretrizes

• não invente uma nova arquitetura de integração quando o repositório já possui uma
• não comece apenas pela documentação do fornecedor; comece primeiro pelos conectores existentes no repositório
• não pare no código de transporte se o repositório espera fiação de registro, testes e documentação
• não copie cegamente conectores antigos se o repositório tem um padrão atual mais recente

Fluxo de Trabalho

1. Aprenda o estilo da casa

Inspecione pelo menos 2 conectores/provedores existentes e mapeie:

• layout de arquivos
• limites de abstração
• modelo de configuração
• convenções de repetição / paginação
• ganchos de registro
• fixtures de teste e nomenclatura

2. Defina a integração alvo

Defina apenas a superfície que o repositório realmente precisa:

• fluxo de autenticação
• entidades chave
• operações principais de leitura/escrita
• paginação e limites de taxa
• webhook ou modelo de polling

3. Construa em camadas nativas ao repositório

Fatias típicas:

• config/schema
• cliente/transporte
• camada de mapeamento
• ponto de entrada do conector/provedor
• registro
• testes

4. Valide contra o padrão de origem

O novo conector deve parecer óbvio no código, não importado de um ecossistema diferente.

Formas de Referência

Estilo Provedor

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

Estilo Conector

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

Estilo Plugin TypeScript

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

Lista de Verificação de Qualidade

• corresponde a um padrão de integração existente no repositório
• validação de configuração existe
• autenticação e tratamento de erros são explícitos
• comportamento de paginação/repetição segue as normas do repositório
• fiação de registro/descoberta está completa
• testes espelham o estilo do repositório anfitrião
• documentação/exemplos são atualizados se esperados pelo repositório

Habilidades Relacionadas

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