agent-docs-api-openapi
Automatyczne tworzenie i utrzymanie dokumentacji OpenAPI dla Twoich API
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Umiejętność agenta do generowania, edytowania i zarządzania specyfikacjami OpenAPI 3.0 oraz dokumentacją Swagger. Pracuje z plikami YAML i JSON, automatycznie rozpoznaje wzorce dokumentacji API i wspiera interaktywne dokumenty. Idealny dla zespołów deweloperskich, które chcą utrzymywać aktualne i spójne API docs bez ręcznej pracy.
Jak używać
Zainstaluj umiejętność agent-docs-api-openapi w swoim środowisku Claude Flow, dodając ją do konfiguracji agenta. Upewnij się, że masz dostęp do repozytorium https://github.com/ruvnet/claude-flow/tree/main/.agents/skills/agent-docs-api-openapi.
Przygotuj strukturę katalogów dla dokumentacji API — agent będzie szukać plików w folderach docs/, api/, openapi/ lub swagger/ oraz plików z rozszerzeniami .yaml, .yml i .json.
Wyzwól agenta, wpisując $agent-docs-api-openapi w kontekście swojego projektu lub używając słów kluczowych takich jak "api documentation", "openapi", "swagger" albo "create openapi spec".
Opisz zadanie, które chcesz wykonać — na przykład "document my REST API", "create openapi spec" lub "update api documentation". Agent automatycznie zidentyfikuje pliki do edycji na podstawie wzorców nazewnictwa.
Agent będzie czytać, edytować i modyfikować pliki dokumentacji, wspierając specyfikację OpenAPI 3.0. Może pracować równolegle na wielu plikach (do 50 operacji) i będzie wymagać potwierdzenia przed usunięciem dokumentacji lub zmianą wersji API.
Przejrzyj wygenerowaną dokumentację — agent zwraca podsumowanie zmian z fragmentami kodu. Jeśli potrzebujesz analizy API, agent może delegować zadania do umiejętności analyze-api.