api-docs-gen
Generuj dokumentację API z plików tras w kilka sekund – markdown i OpenAPI bez konfiguracji
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Narzędzie do automatycznego generowania dokumentacji API bezpośrednio z kodu tras. Skanuje Twoje pliki, wyciąga informacje o endpointach i tworzy czystą dokumentację w formacie markdown lub specyfikację OpenAPI 3.0 gotową do Swagger UI. Idealne, gdy dziedziczysz projekt bez dokumentacji lub chcesz szybko udokumentować MVP. Działa bez konfiguracji – wystarczy jedna komenda.
Jak używać
Upewnij się, że masz zainstalowany Node.js 18 lub nowszy oraz zmienną środowiskową OPENAI_API_KEY ustawioną w systemie.
Przejdź do katalogu projektu, w którym znajdują się pliki tras (np. src/routes/).
Uruchom narzędzie komendą npx ai-api-docs ./src/routes/ – automatycznie wygeneruje plik API_DOCS.md z dokumentacją w formacie markdown.
Jeśli potrzebujesz specyfikacji OpenAPI zamiast markdown, użyj flagi --format openapi -o spec.yaml, aby zapisać wynik w pliku YAML kompatybilnym ze Swagger UI.
Przejrzyj wygenerowaną dokumentację i uzupełnij brakujące opisy kontekstu – narzędzie poprawnie wyodrębnia strukturę, ale Ty dodasz szczegóły biznesowe.
Dodaj generowanie dokumentacji do pipeline'u CI, aby dokumentacja aktualizowała się automatycznie przy zmianach w kodzie tras.