paasta-api-endpoint
Automatyczne generowanie endpointów API w PaaSTa z dokumentacją i testami
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill do szybkiego tworzenia nowych endpointów API w systemie PaaSTa. Automatycznie generuje funkcje widoku, rejestruje trasy, dodaje dokumentację Swagger 2.0 i OpenAPI 3.0, tworzy testy jednostkowe i weryfikuje implementację. Oszczędza czas przy dodawaniu endpointów GET, POST, PUT i DELETE, zapewniając spójność z istniejącymi wzorcami w projekcie.
Jak używać
Uruchom skill poleceniem /paasta-api-endpoint w swoim środowisku Claude/Copilot. Skill poprosi Cię o interaktywne podanie wymagań dla nowego endpointu.
Odpowiedz na pytania dotyczące celu endpointu (co robi), metody HTTP (GET, POST, PUT lub DELETE), ścieżki URL (np. /v1/services/{service}/instances/{instance}/status) oraz parametrów ścieżki (np. service, instance, deploy_group).
Określ parametry zapytania (query parameters), jeśli są potrzebne, oraz strukturę ciała żądania (request body) — podaj pola, które endpoint powinien przyjmować.
Opisz strukturę odpowiedzi, którą endpoint zwróci (np. {"status": "running"}).
Skill automatycznie wygeneruje funkcję widoku w katalogu paasta_tools/api/views/, zarejestruje trasę w paasta_tools/api/api.py, doda dokumentację do swagger.json i oapi.yaml, oraz utworzy testy jednostkowe zgodnie z konwencjami PaaSTa.
Skill uruchomi generator kodu OpenAPI i testy, aby zweryfikować poprawność implementacji. Sprawdź wyniki i upewnij się, że wszystkie testy przeszły pomyślnie.