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, et non simplement un client HTTP générique.

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

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

Quand l'utiliser

• "Construire un connecteur Jira pour ce projet"
• "Ajouter un fournisseur Slack selon le modèle existant"
• "Créer une nouvelle intégration pour cette API"
• "Construire un plugin qui correspond au style de connecteur du dépôt"

Garde-fous

• n'inventez pas une nouvelle architecture d'intégration si le dépôt en a déjà une
• ne commencez pas uniquement par la documentation du fournisseur ; commencez d'abord 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 les anciens connecteurs si le dépôt a un modèle plus récent et actuel

Flux de travail

1. Apprendre le style de la maison

Inspectez au moins 2 connecteurs/fournisseurs existants et cartographiez :

• disposition des fichiers
• limites d'abstraction
• modèle de configuration
• conventions sur les tentatives / pagination
• hooks d'enregistrement
• fixtures de test et leur 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 taux
• modèle webhook ou polling

3. Construire en couches natives du dépôt

Tranches typiques :

• configuration/schéma
• client/transport
• couche de mappage
• point d'entrée connecteur/fournisseur
• enregistrement
• tests

4. Valider par rapport au modèle source

Le nouveau connecteur doit paraître évident dans la base de code, et non 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 la configuration existe
• l'authentification et la gestion des erreurs sont explicites
• le comportement de pagination/tentatives 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/les exemples sont mis à jour si le dépôt l'attend

Compétences associées

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