A
api-design-principles
Projektuj API REST i GraphQL zgodnie z najlepszymi praktykami — intuicyjne, skalowalne i łatwe w utrzymaniu.
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill do opanowania zasad projektowania API REST i GraphQL. Pomaga w tworzeniu nowych interfejsów API, refaktoryzacji istniejących, ustalaniu standardów projektowania dla zespołu oraz przeglądaniu specyfikacji przed wdrożeniem. Obejmuje zasady architektur zorientowanych na zasoby, semantykę metod HTTP, projektowanie schematu GraphQL, strategie wersjonowania i wzorce projektowe. Idealne dla deweloperów backend, architektów systemów i zespołów chcących ustanowić spójne standardy API.
Jak używać
- Zainstaluj skill w swoim środowisku agenta Claude/Copilot, dodając go do katalogu pluginów backend-development.
- Uruchom skill, gdy planujesz nowy projekt API — podaj kontekst (REST czy GraphQL, cel użytkownika, przypadki użycia).
- Skorzystaj z wytycznych dotyczących architektury zorientowanej na zasoby: definiuj zasoby jako rzeczowniki (użytkownicy, zamówienia, produkty), a akcje mapuj na metody HTTP (GET, POST, PUT, PATCH, DELETE).
- Dla API GraphQL zastosuj podejście schema-first — zdefiniuj typy domeny, operacje odczytu (queries), modyfikacji (mutations) i aktualizacji w czasie rzeczywistym (subscriptions).
- Wybierz strategię wersjonowania (URL, nagłówek HTTP lub parametr zapytania) i konsekwentnie ją stosuj w całym projekcie.
- Użyj skilla do przeglądu specyfikacji API przed implementacją lub podczas refaktoryzacji istniejących interfejsów w celu poprawy użyteczności i zgodności ze standardami zespołu.