V
validating-api-responses
Validate API responses against schemas to ensure contract compliance and data integrity.\nUse when ensuring API response correctness.\nTrigger with phrases like \
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Validate API responses against schemas to ensure contract compliance and data integrity.\nUse when ensuring API response correctness.\nTrigger with phrases like \
How to use
- Przygotuj specyfikację OpenAPI 3.0+ ze zdefiniowanymi schematami odpowiedzi dla wszystkich endpointów, uwzględniając odpowiedzi sukcesu (200, 201), błędy (400, 404, 500) i definicje nagłówków.
- Zainstaluj validator JSON Schema odpowiedni dla twojego środowiska: Ajv dla Node.js, jsonschema dla Pythona lub everit-org/json-schema dla Javy.
- Wczytaj specyfikację OpenAPI za pomocą komendy Read i wyodrębnij wszystkie schematy odpowiedzi dla każdego endpointa, włączając definicje nagłówków.
- Skonfiguruj middleware walidacji odpowiedzi, które przechwytuje wychodzące odpowiedzi i weryfikuje treść względem odpowiedniego schematu, logując naruszenia bez blokowania odpowiedzi w produkcji.
- Ustaw poziom ścisłości walidacji dla każdego środowiska: tryb strict (zawodź na naruszeniach) dla development/staging, tryb permissive dla produkcji, aby uniknąć przerw w usłudze.
- Zintegruj skill z pipelineiem CI, aby uruchamiać testy kontraktu po wdrożeniu i wykrywać zmiany schematu między wersjami API przy użyciu narzędzia do porównywania schematów.