api-contract-sync-manager
Validate OpenAPI, Swagger, and GraphQL schemas match backend implementation. Detect breaking changes, generate TypeScript clients, and ensure API documentation stays synchronized. Use when working with API spec files (.yaml, .json, .graphql), reviewing API changes, generating
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Validate OpenAPI, Swagger, and GraphQL schemas match backend implementation. Detect breaking changes, generate TypeScript clients, and ensure API documentation stays synchronized. Use when working with API spec files (.yaml, .json, .graphql), reviewing API changes, generating frontend types, or validating endpoint implementations.
How to use
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.