backend-to-frontend-handoff-docs
Generuj dokumentację API dla frontend developerów w kilka sekund
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Umiejętność do automatycznego tworzenia dokumentacji handoff dla frontend developerów po zakończeniu pracy nad API. Generuje strukturalną dokumentację z wszystkimi szczegółami technicznymi, kontekstem biznesowym i przykładami request/response, którą frontend może od razu wykorzystać do budowy integracji bez dodatkowych pytań do backendu.
Jak używać
Przygotuj ukończony kod API — upewnij się, że wszystkie endpointy, kontrolery, serwisy i DTO są gotowe do dokumentacji.
Zgromadź kontekst biznesowy — zbierz informacje o nazwie feature'a, powiązanych endpointach, regułach autoryzacji, ograniczeniach i znanych edge case'ach odkrytych podczas implementacji.
Uruchom umiejętność — użyj komendy 'create handoff', 'document API', 'frontend handoff' lub 'API documentation' w kontekście ukończonej pracy backendowej.
Umiejętność wygeneruje dokument handoff w formacie markdown — zawiera on strukturalny opis wszystkich endpointów, DTOs, reguł walidacji i przykładów payload'ów, które frontend potrzebuje do budowy integracji.
Dla prostych API (CRUD bez złożonej logiki biznesowej) umiejętność może pominąć pełny szablon i dostarczyć tylko endpoint, metodę HTTP i przykłady request/response — frontend może resztę wywnioskować z dokumentacji.
Jeśli potrzebujesz aktualizacji dokumentacji po feedback'u — uruchom umiejętność ponownie, a nowa wersja będzie zapisana z przyrostkiem wersji (v2, v3 itd.).