Was macht API-Connector-Builder?
Verwenden Sie dies, wenn die Aufgabe darin besteht, eine reponative Integrationsoberfläche hinzuzufügen, nicht nur einen generischen HTTP-Client.
Der Punkt ist, das Muster des Host-Repositories nachzubilden:
- Connector-Layout
- Konfigurationsschema
- Authentifizierungsmodell
- Fehlerbehandlung
- Teststil
- Registrierungs-/Discovery-Verdrahtung
Wann verwenden
- „Erstellen Sie einen Jira-Connector für dieses Projekt“
- „Fügen Sie einen Slack-Provider hinzu, der dem vorhandenen Muster folgt“
- „Erstellen Sie eine neue Integration für diese API“
- „Erstellen Sie ein Plugin, das dem Connector-Stil des Repositories entspricht“
Leitplanken
- Erfinden Sie keine neue Integrationsarchitektur, wenn das Repository bereits eine hat.
- Beginnen Sie nicht nur mit der Anbieterdokumentation; beginnen Sie zuerst mit vorhandenen Connectors im Repository.
- Hören Sie nicht beim Transportcode auf, wenn das Repository Registry-Verdrahtung, Tests und Dokumentation erwartet.
- Kopieren Sie nicht blind alte Connectors, wenn das Repository ein neueres, aktuelles Muster hat.
Arbeitsablauf
1. Lernen Sie den Hausstil kennen
Überprüfen Sie mindestens 2 vorhandene Connectors/Provider und kartieren Sie:
- Dateilayout
- Abstraktionsgrenzen
- Konfigurationsmodell
- Wiederholungs-/Paginierungskonventionen
- Registry-Hooks
- Test-Fixtures und Benennung
2. Eingrenzen der Zielintegration
Definieren Sie nur die Oberfläche, die das Repository tatsächlich benötigt:
- Authentifizierungsablauf
- Schlüsselentitäten
- Kernlese-/Schreiboperationen
- Paginierung und Ratenbegrenzungen
- Webhook- oder Polling-Modell
3. Bauen Sie in reponativen Schichten
Typische Schichten:
- Konfiguration/Schema
- Client/Transport
- Abbildungsschicht
- Connector/Provider-Einstiegspunkt
- Registrierung
- Tests
4. Validieren gegen das Quellmuster
Der neue Connector sollte im Codebestand offensichtlich wirken, nicht wie aus einem anderen Ökosystem importiert.
Referenzformen
Provider-Stil
providers/
existing_provider/
__init__.py
provider.py
config.py
Connector-Stil
integrations/
existing/
client.py
models.py
connector.py
TypeScript-Plugin-Stil
src/integrations/
existing/
index.ts
client.ts
types.ts
test.ts
Qualitätscheckliste
- Entspricht einem vorhandenen Integrationsmuster im Repository
- Konfigurationsvalidierung existiert
- Authentifizierung und Fehlerbehandlung sind explizit
- Paginierungs-/Wiederholungsverhalten folgt den Repository-Normen
- Registrierungs-/Discovery-Verdrahtung ist vollständig
- Tests spiegeln den Stil des Host-Repositories wider
- Dokumentation/Beispiele werden aktualisiert, falls vom Repository erwartet
Verwandte Skills
backend-patternsmcp-server-patternsgithub-ops