API Documentation Generator
Dokumentuje istniejące trasy API w formacie markdown/OpenAPI; nie tworzy kodu nowych punktów końcowych.
Działa po konfiguracji
Co robi ten skill
Skanuje istniejące handlery tras (Express, FastAPI, Spring Boot, Go) pod kątem metody, ścieżki, parametrów i uwierzytelniania, a następnie wypełnia dołączony szablon endpoint.md w dokumentację markdown lub specyfikację OpenAPI 3.0; dostarcza rzeczywisty skaner detect_routes.py i skrypt walidujący validate_openapi.sh, które działają niezależnie. Jego własne frontmatter przesadza: mówi 'używaj, gdy użytkownik chce tworzyć nowe punkty końcowe API, generować handlery tras, tworzyć szablony REST API', ale treść dokumentuje tylko istniejące punkty końcowe — nie ma kroku generowania kodu. Dołączone szablony/openapi.yaml również nie są poprawnym formatem YAML w stanie dostarczonym; jego tokeny {PLACEHOLDER} są dosłowne, więc jego własny walidator odrzuca go, dopóki ich nie wypełnisz.
Raport z testu
Uruchomiono dołączone skrypty w praktyce: detect_routes.py poprawnie znalazł wszystkie 4 trasy w dwóch plikach testowych, ale validate_openapi.sh zawiesił się na własnych szablonach skilla/openapi.yaml — jego tokeny {PLACEHOLDER} są nieprawidłowymi kluczami mapowania przepływu YAML, więc dołączony szablon zawodzi dołączony walidator, dopóki go najpierw ręcznie nie wypełnisz. (Wymienione tutaj pod naszą starszą nazwą; własna nazwa skilla to "API Documentation Generator".)
Testowano: 2026-07-14 · Claude Code 2.x (agent harness)
Instalacja
git clone https://github.com/huangjia2019/claude-code-engineering cd claude-code-engineering mkdir -p ~/.claude/skills cp -r 04-Skills/projects/05-api-generator ~/.claude/skills/api-docs-generator
Komendy i przykładowe prompty
/api-docs-generatorDokumentuje istniejące trasy API w formacie markdown/OpenAPI; nie tworzy kodu nowych punktów końcowych.
Skille uruchamiają się na zwykłe polecenia — bez komend do zapamiętania. Po instalacji aktywują go prompty takie jak te (po angielsku):
Generate reference docs from these route handlersDocument this API's endpoints from the schema filesProduce endpoint documentation for my REST API code