A
api-design-principles
Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers. Use when designing new APIs, reviewing API specifications, or establishing API design standards.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers. Use when designing new APIs, reviewing API specifications, or establishing API design standards.
How to use
- 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.