A
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
API Design Reviewer
How to use
- Zainstaluj skill API Design Reviewer w swoim środowisku Claude lub Codex, dodając go do listy dostępnych umiejętności inżynieryjnych.
- Przygotuj dokumentację lub specyfikację swojego API — może to być plik OpenAPI, opis endpointów lub kod definiujący interfejs.
- Przekaż skill swoją aktualną specyfikację API, wskazując, które aspekty chcesz przeanalizować — konwencje nazewnictwa, strukturę odpowiedzi, status kody lub dokumentację.
- Skill przeprowadzi linting konwencji REST — sprawdzi nazewnictwo zasobów (kebab-case), użycie metod HTTP, spójność URL-i i formaty błędów.
- 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.
- 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.