api-designer
Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture. Invoke for resource modeling, versioning strategies, pagination patterns, error handling standards.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture. Invoke for resource modeling, versioning strategies, pagination patterns, error handling standards.
How to use
Załaduj skill api-designer w swoim środowisku agenta (np. Claude, Copilot). Skill automatycznie aktywuje się, gdy napiszesz prompt zawierający słowa kluczowe takie jak "API design", "REST API", "OpenAPI" lub "GraphQL schema".
Opisz swoje wymagania biznesowe i strukturę danych. Powiedz mi, jakie zasoby chcesz modelować, jakie operacje będą dostępne i kto będzie konsumować Twoje API (aplikacje mobilne, frontendy, usługi trzecie).
Skill przeanalizuje domenę i zaproponuje model zasobów. Otrzymasz identyfikację kluczowych encji, relacji między nimi oraz sugerowane operacje (GET, POST, PUT, DELETE).
Zdefiniuję endpointy i schematy. Skill zaprojektuje URI patterns, metody HTTP, struktury request/response oraz utworzy pełną specyfikację OpenAPI 3.1 z dokumentacją.
Zaplanujemy strategię wersjonowania i ewolucji API. Omówię podejście do zmian breaking, deprecacji funkcji i kompatybilności wstecznej, aby Twoje API mogło rosnąć bez psowania istniejących klientów.
Otrzymasz gotową specyfikację w formacie OpenAPI, którą możesz od razu użyć do generowania dokumentacji, SDK-ów lub testów.