api-contract-sync-manager
Synchronizuj specyfikacje API z implementacją, wykrywaj zmiany i generuj klienty TypeScript
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Narzędzie do zarządzania synchronizacją między specyfikacjami OpenAPI, Swagger i GraphQL a rzeczywistą implementacją backendu. Automatycznie waliduje schematy, wykrywa zmiany mogące złamać kompatybilność, generuje typy TypeScript dla frontendu i zapewnia, że dokumentacja API pozostaje aktualna. Idealne dla zespołów pracujących nad API-driven projektami, podczas code review zmian w API oraz przy onboardingu nowych deweloperów.
Jak używać
Zainstaluj umiejętność w swoim środowisku agenta, upewniając się, że masz dostęp do narzędzi Read, Grep, Glob i RunTerminalCmd.
Przygotuj pliki specyfikacji API — mogą to być pliki OpenAPI/Swagger w formacie YAML lub JSON, bądź schematy GraphQL w formacie .graphql lub .gql.
Uruchom walidację specyfikacji, wskazując ścieżkę do pliku. Narzędzie sprawdzi poprawność składni, struktury, referencji ($ref), wymagane pola oraz zgodność z standardami OpenAPI 3.0/3.1 lub SDL dla GraphQL.
Przeanalizuj wyniki walidacji — narzędzie wskaże brakujące pola, nieprawidłowe referencje, niespójności w nazewnictwie oraz problemy z bezpieczeństwem.
Generuj typy TypeScript i kod klienta na podstawie zwalidowanej specyfikacji, aby zsynchronizować frontend z dokumentacją API.
Podczas przeglądania zmian w pull requestach użyj narzędzia do wykrycia zmian mogących złamać kompatybilność (breaking changes) i ocenienia wpływu na istniejące klienty.