api-design-reviewer

Skill do kompleksowej oceny projektów API REST. Weryfikuje konwencje nazewnictwa, użycie metod HTTP, strukturę odpowiedzi i zgodność ze standardami branżowymi. Automatycznie wykrywa zmiany mogące złamać integracje klientów — usunięte endpointy, zmienione typy pól, nowe wymagane pola. Generuje raport oceny API na podstawie spójności, dokumentacji, bezpieczeństwa i użyteczności. Idealne dla zespołów inżynieryjnych chcących utrzymać wysoką jakość i stabilność swoich interfejsów.

1. Zainstaluj skill API Design Reviewer w swoim środowisku Claude lub Codex, dodając go do listy dostępnych umiejętności inżynieryjnych.
2. Przygotuj dokumentację lub specyfikację swojego API — może to być plik OpenAPI, opis endpointów lub kod definiujący interfejs.
3. Przekaż skill swoją aktualną specyfikację API, wskazując, które aspekty chcesz przeanalizować — konwencje nazewnictwa, strukturę odpowiedzi, status kody lub dokumentację.
4. Skill przeprowadzi linting konwencji REST — sprawdzi nazewnictwo zasobów (kebab-case), użycie metod HTTP, spójność URL-i i formaty błędów.
5. Jeśli posiadasz wcześniejszą wersję API, dostarczył ją jako punkt odniesienia — skill automatycznie wykryje zmiany łamiące kompatybilność, takie jak usunięte endpointy, zmienione typy pól czy nowe wymagane pola.
6. Przejrzyj wygenerowany raport oceny, który ocenia Twoje API w czterech wymiarach: spójność (30%), jakość dokumentacji (20%), bezpieczeństwo (20%) i użyteczność (15%) — wykorzystaj wyniki do poprawy projektu.