Toolverse
Wszystkie skille

validating-api-responses

autor: jeremylongshore

Sprawdzaj odpowiedzi API pod kątem zgodności ze schematem i integralności danych

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

O skillu

Skill do walidacji odpowiedzi API względem schematów OpenAPI i JSON Schema. Automatycznie weryfikuje, czy każda odpowiedź z API zgadza się z dokumentacją kontraktu, wykrywając naruszenia struktury danych, nieudokumentowane pola i regresje kompatybilności wstecznej. Uruchamiaj walidację w middleware'u na etapie development/staging lub jako testy kontraktu po wdrożeniu. Obsługuje wszystkie kody statusu HTTP (200, 201, 400, 404, 500) i nagłówki odpowiedzi.

Jak używać

  1. 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.
  2. Zainstaluj validator JSON Schema odpowiedni dla twojego środowiska: Ajv dla Node.js, jsonschema dla Pythona lub everit-org/json-schema dla Javy.
  3. Wczytaj specyfikację OpenAPI za pomocą komendy Read i wyodrębnij wszystkie schematy odpowiedzi dla każdego endpointa, włączając definicje nagłówków.
  4. 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.
  5. 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.
  6. 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.

Podobne skille