api-connector-builder

Constructor de Conectores API

Úsalo cuando la tarea sea agregar una superficie de integración nativa del repositorio, no solo un cliente HTTP genérico.

El objetivo es adaptarse al patrón del repositorio anfitrión:

• estructura del conector
• esquema de configuración
• modelo de autenticación
• manejo de errores
• estilo de pruebas
• cableado de registro / descubrimiento

Cuándo Usarlo

• "Construye un conector para Jira en este proyecto"
• "Agrega un proveedor de Slack siguiendo el patrón existente"
• "Crea una nueva integración para esta API"
• "Construye un plugin que coincida con el estilo de conector del repositorio"

Guardas

• no inventes una nueva arquitectura de integración cuando el repositorio ya tiene una
• no empieces solo con la documentación del proveedor; empieza primero revisando los conectores existentes en el repositorio
• no te detengas en el código de transporte si el repositorio espera cableado de registro, pruebas y documentación
• no copies patrones antiguos si el repositorio tiene un patrón más reciente y actual

Flujo de Trabajo

1. Aprende el estilo de la casa

Inspecciona al menos 2 conectores/proveedores existentes y mapea:

• estructura de archivos
• límites de abstracción
• modelo de configuración
• convenciones de reintento / paginación
• hooks de registro
• fixtures y nombres de pruebas

2. Delimita la integración objetivo

Define solo la superficie que el repositorio realmente necesita:

• flujo de autenticación
• entidades clave
• operaciones básicas de lectura/escritura
• paginación y límites de tasa
• modelo de webhook o polling

3. Construye en capas nativas del repositorio

Capas típicas:

• configuración/esquema
• cliente/transporte
• capa de mapeo
• punto de entrada del conector/proveedor
• registro
• pruebas

4. Valida contra el patrón de origen

El nuevo conector debería verse obvio en el código base, no importado de un ecosistema diferente.

Formas de Referencia

Estilo Proveedor

providers/
  proveedor_existente/
    __init__.py
    provider.py
    config.py

Estilo Conector

integrations/
  existente/
    client.py
    models.py
    connector.py

Estilo Plugin TypeScript

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

Lista de Verificación de Calidad

• coincide con un patrón de integración existente en el repositorio
• existe validación de configuración
• la autenticación y el manejo de errores son explícitos
• el comportamiento de paginación/reintento sigue las normas del repositorio
• el cableado de registro/descubrimiento está completo
• las pruebas reflejan el estilo del repositorio anfitrión
• la documentación/ejemplos están actualizados si el repositorio lo espera

Habilidades Relacionadas

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