validating-api-schemas

Skill do walidacji specyfikacji API przeciwko OpenAPI 3.0/3.1, JSON Schema Draft 2020-12 i standardom GraphQL SDL. Automatycznie wykrywa niekompletne schematy, nieudokumentowane endpointy, niespójne konwencje nazewnictwa i zmiany powodujące błędy, zanim trafią do konsumentów. Wykorzystuje reguły lintingu, analizę strukturalną i egzekwowanie najlepszych praktyk. Idealny dla zespołów API development chcących zapewnić jakość i spójność kontraktów przed wdrożeniem.

1. Przygotuj pliki specyfikacji API — upewnij się, że masz dostęp do plików OpenAPI (YAML lub JSON), definicji JSON Schema lub plików GraphQL SDL w swoim projekcie.
2. Zainstaluj narzędzia walidacyjne wymagane dla Twojego standardu: Spectral do OpenAPI, graphql-schema-linter do GraphQL lub ajv-cli do JSON Schema.
3. Wyzwól skill frazą taką jak "validate API schema", "check OpenAPI spec" lub "verify schema" w kontekście pliku specyfikacji.
4. Skill automatycznie zlokalizuje wszystkie pliki specyfikacji w projekcie, przeprowadzi walidację strukturalną i sprawdzi zgodność z deklarowanym standardem (OpenAPI 3.0, 3.1 lub JSON Schema Draft 2020-12).
5. Przeanalizuj wyniki lintingu — skill zastosuje reguły egzekwujące konwencje nazewnictwa (camelCase dla właściwości, kebab-case dla ścieżek), wymaga opisów dla wszystkich operacji i przykładowych wartości dla schematów żądań i odpowiedzi.
6. Zweryfikuj kompletność schematu: każdy endpoint powinien mieć udokumentowany schemat żądania, wszystkie kody statusu odpowiedzi powinny mieć schematy (w tym 400, 401, 404, 500) i wszystkie referencje $ref powinny być rozwiązane. Opcjonalnie skonfiguruj walidację w pipeline CI, aby automatycznie sprawdzać schematy przy każdym pull request.