api-contract

API Contract to umiejętność wspierająca tworzenie plików api-contract.md, które stanowią wspólny interfejs między agentami backend i frontend podczas wykonywania sprintów. Skill pomaga zdefiniować schematy żądań i odpowiedzi, trasy endpointów, interfejsy TypeScript oraz formaty błędów. Dzięki temu agenci implementacyjni pracują zgodnie z ustaloną specyfikacją bez konieczności bezpośredniej komunikacji. Idealny dla zespołów budujących lub modyfikujących endpointy API w oparciu o konwencje RESTful.

1. Upewnij się, że masz zainicjowany katalog sprintu w .claude/sprint/[N]/ oraz plik specs.md zawierający zakres funkcjonalności i wymagania dotyczące endpointów.

2. 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".

3. Utwórz plik api-contract.md w 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.

4. Zdefiniuj interfejsy TypeScript dla wszystkich typów żądań i odpowiedzi. Używaj jawnych typów zamiast any, oznaczaj pola opcjonalne znakiem ? oraz używaj string | null dla wartości nullable'owych. Odwołaj się do ${CLAUDE_SKILL_DIR}/references/typescript-interfaces.md w celu poznania kanonicznych wzorców typów.

5. Dla endpointów listy dodaj parametry paginacji i strukturę PaginatedResponse zgodnie z dokumentacją referencyjną skill'u.

6. Udostępnij gotowy plik api-contract.md agentom backend i frontend, aby pracowali nad wspólnie uzgodnioną specyfikacją bez konieczności dodatkowej koordynacji.