Toolverse
Wszystkie skille

endpoint-validator

autor: mikopbx

Waliduj REST API zgodnie ze schematem OpenAPI i sprawdzaj spójność parametrów

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Autor
mikopbx
Wyświetlenia
3

O skillu

Skill do walidacji endpointów REST API pod kątem zgodności z OpenAPI, spójności parametrów i prawidłowej implementacji. Automatycznie sprawdza strukturę DataStructure.php, weryfikuje wzorzec siedmiofazowy w SaveRecordAction.php i testuje tryb SCHEMA_VALIDATION_STRICT. Generuje raport zgodności z konkretnymi rekomendacjami. Używaj przy implementacji nowych endpointów, modyfikacji istniejących, przeglądzie zmian API lub przed mergowaniem pull requestów.

Jak używać

  1. Zidentyfikuj zasób API, który chcesz walidować (np. Extensions, Providers, IncomingRoutes). Skill będzie szukać plików DataStructure.php i SaveRecordAction.php w katalogu src/PBXCoreREST/Lib/{Zasób}/. 2. Uruchom skill, podając nazwę zasobu. Skill automatycznie zlokalizuje wymagane pliki i przeanalizuje ich strukturę. 3. Skill sprawdzi, czy DataStructure.php zawiera metodę getParameterDefinitions() z pełną definicją parametrów — każdy parametr musi mieć type, description, example i required. 4. Skill zweryfikuje, czy SaveRecordAction.php implementuje siedmiofazowy wzorzec przetwarzania zgodnie ze standardem MikoPBX. 5. Skill przetestuje tryb SCHEMA_VALIDATION_STRICT, aby upewnić się, że walidacja schematu działa poprawnie. 6. Otrzymasz raport zgodności z listą problemów i rekomendacji do naprawienia przed mergowaniem zmian do API.

Podobne skille