← Zurück zu Entwickler interner Systeme
Entdecke, wie der Skill hilft
API-Kompatibilität prüfen
Prüft geänderte Schnittstellen auf Folgen für bestehende Clients, wartende Arbeit und erwartetes Fehlerverhalten von Integrationen.
api-compatibility-review
Teammitglieder mit diesem Skill
Wann ist der Skill hilfreich?
Nutze dies, wenn sich ein Endpunkt oder eine gemeinsame Schnittstelle ändert und ältere Clients weiter funktionieren müssen.
Wobei hilft er dir?
- Ermittelt betroffene Aufrufer, ältere Browsersitzungen und bereits eingereihte Nachrichten.
- Prüft Pflichtfelder, Antworttypen, Standardwerte und Seitennavigation auf inkompatible Änderungen.
- Untersucht strukturierte Fehler, Wiederholungsschutz und den Umgang mit veralteten Aktualisierungen.
Das könntest du fragen
Prüfe die Entfernung des Bestellstatusfeldes: ermittle betroffene Verbraucher und schlage einen kompatiblen Übergang vor. Spiele eine alte Client-Anfrage und ein wartendes Ereignis gegen den neuen Vertrag ab. Zeige betroffene Verbraucher und einen weiterhin funktionierenden Übergang.
Ausführliche Dokumentation
Hier findest du die ursprüngliche Anleitung, Beispiele und Prüfschritte des Skills in ihrer Originalsprache.
Weniger anzeigen
API & Compatibility Review
Use this skill when reviewing changes that touch HTTP/REST/GraphQL/RPC endpoints, webhook/event payloads, CLI flags, configuration keys, or exported module signatures.
Workflow
- Inventory all consumers of the modified interface:
- Search the entire monorepo or project (
grep/ symbol references) for every internal caller, UI client, SDK wrapper, background worker, and test fixture that consumes the changed interface. - Consider external or persisted consumers: saved webhooks, queued job payloads already in flight, browser tabs running slightly older frontend bundles, and external API clients.
- Search the entire monorepo or project (
- Check for breaking contract changes:
- Request / Input contract:
- Making an optional field required without a default value.
- Narrowing accepted enum values, types, or validation bounds without migrating existing callers.
- Renaming or removing query parameters, headers, or body properties.
- Response / Output contract:
- Removing, renaming, or changing the type/nullability of returned fields.
- Changing pagination structure, sorting defaults, or error status codes/codes that clients branch on.
- Configuration & environment defaults:
- Changing a default config value in a way that alters production behavior when the env var is unset.
- Request / Input contract:
- Verify error contracts and idempotency:
- Confirm that validation failures, missing resources, permission denials, and version conflicts return the project's standard structured error codes and HTTP statuses.
- Verify that mutating endpoints preserve idempotency and concurrency guards (
expectedVersion,Idempotency-Key).
Enthaltene Dateien 1
SKILL.md