V
validating-api-schemas
Validate API schemas against OpenAPI, JSON Schema, and GraphQL specifications.\nUse when validating API schemas and contracts.\nTrigger with phrases like \
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Validate API schemas against OpenAPI, JSON Schema, and GraphQL specifications.\nUse when validating API schemas and contracts.\nTrigger with phrases like \
How to use
- 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.
- Zainstaluj narzędzia walidacyjne wymagane dla Twojego standardu: Spectral do OpenAPI, graphql-schema-linter do GraphQL lub ajv-cli do JSON Schema.
- Wyzwól skill frazą taką jak "validate API schema", "check OpenAPI spec" lub "verify schema" w kontekście pliku specyfikacji.
- 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).
- 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.
- 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.