Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Configure this skill should be used when the user asks about \
How to use
Upewnij się, że masz zainicjowany katalog sprintu w
.claude/sprint/[N]/oraz plikspecs.mdzawierający zakres funkcjonalności i wymagania dotyczące endpointów.Wyzwól skill, gdy użytkownik pyta o "API contract", "api-contract.md", "shared interface", "TypeScript interfaces", "request response schemas" lub "endpoint design". Możesz też użyć go, gdy usłyszysz frazy takie jak "create API", "design endpoint" lub "API scaffold".
Utwórz plik
api-contract.mdw katalogu sprintu (.claude/sprint/[N]/api-contract.md). Dla każdego endpointu zdefiniuj metodę HTTP, ścieżkę, opis, ciało żądania, ciało odpowiedzi ze statusem oraz kody błędów, korzystając ze standardowego formatu dostępnego w${CLAUDE_SKILL_DIR}/references/writing-endpoints.md.Zdefiniuj interfejsy TypeScript dla wszystkich typów żądań i odpowiedzi. Używaj jawnych typów zamiast
any, oznaczaj pola opcjonalne znakiem?oraz używajstring | nulldla wartości nullable'owych. Odwołaj się do${CLAUDE_SKILL_DIR}/references/typescript-interfaces.mdw celu poznania kanonicznych wzorców typów.Dla endpointów listy dodaj parametry paginacji i strukturę
PaginatedResponsezgodnie z dokumentacją referencyjną skill'u.Udostępnij gotowy plik
api-contract.mdagentom backend i frontend, aby pracowali nad wspólnie uzgodnioną specyfikacją bez konieczności dodatkowej koordynacji.