Constructeur de connecteur API

Que fait Constructeur de connecteur API ?

Utilisez ceci lorsque la tâche consiste à ajouter une surface d'intégration native au dépôt, pas seulement un client HTTP générique.

Le but est de respecter le modèle du dépôt hôte :

• disposition des connecteurs
• schéma de configuration
• modèle d'authentification
• gestion des erreurs
• style de test
• câblage d'enregistrement/découverte

Quand l'utiliser

• "Construis un connecteur Jira pour ce projet"
• "Ajoute un fournisseur Slack en suivant le modèle existant"
• "Crée une nouvelle intégration pour cette API"
• "Construis un plugin qui respecte le style de connecteur du dépôt"

Garde-fous

• n'inventez pas une nouvelle architecture d'intégration quand le dépôt en a déjà une
• ne partez pas uniquement de la documentation du fournisseur ; commencez par les connecteurs existants dans le dépôt
• ne vous arrêtez pas au code de transport si le dépôt attend un câblage d'enregistrement, des tests et de la documentation
• ne reproduisez pas aveuglément d'anciens connecteurs si le dépôt possède un modèle plus récent

Flux de travail

1. Apprendre le style maison

Inspectez au moins 2 connecteurs/fournisseurs existants et cartographiez :

• disposition des fichiers
• limites d'abstraction
• modèle de configuration
• conventions de reprise / pagination
• hooks d'enregistrement
• fixtures de test et conventions de nommage

2. Réduire l'intégration cible

Définissez uniquement la surface dont le dépôt a réellement besoin :

• flux d'authentification
• entités clés
• opérations de lecture/écriture principales
• pagination et limites de débit
• modèle de webhook ou de polling

3. Construire dans les couches natives du dépôt

Tranches typiques :

• config/schéma
• client/transport
• couche de mapping
• point d'entrée du connecteur/fournisseur
• enregistrement
• tests

4. Valider par rapport au modèle source

Le nouveau connecteur doit sembler évident dans la base de code, pas importé d'un écosystème différent.

Formes de référence

Style fournisseur

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

Style connecteur

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

Style plugin TypeScript

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

Liste de contrôle qualité

• correspond à un modèle d'intégration existant dans le dépôt
• la validation de configuration existe
• l'authentification et la gestion des erreurs sont explicites
• le comportement de pagination/reprise suit les normes du dépôt
• le câblage d'enregistrement/découverte est complet
• les tests reflètent le style du dépôt hôte
• la documentation et les exemples sont mis à jour si attendus par le dépôt

Compétences associées

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