api-docs-gen
Generate API documentation from route files. Use when you need markdown or OpenAPI specs fast.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Generate API documentation from route files. Use when you need markdown or OpenAPI specs fast.
How to use
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.