api-documentation-generator
Generuj profesjonalną dokumentację API bezpośrednio z kodu
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Automatycznie twórz kompletną dokumentację API na podstawie analizy Twojego kodu. Skill generuje opisy endpointów, parametry, przykłady żądań i odpowiedzi, wymagania autentykacji oraz wytyczne obsługi błędów. Wspiera REST, GraphQL i WebSocket. Idealne do dokumentowania nowych API, aktualizacji istniejącej dokumentacji oraz przygotowania specyfikacji OpenAPI/Swagger dla nowych programistów i użytkowników zewnętrznych.
Jak używać
Przygotuj kod Twojego API — upewnij się, że masz dostęp do plików źródłowych zawierających definicje endpointów, routy, parametry i logikę autentykacji.
Uruchom skill i wskaż ścieżkę do kodu API — skill przeanalizuje strukturę Twojego API, identyfikując dostępne endpointy, metody HTTP (GET, POST, PUT, DELETE), parametry żądań, formaty odpowiedzi, kody statusu oraz wymagania autentykacji.
Skill wygeneruje dokumentację dla każdego endpointa — obejmie ona opis funkcji, wymagania autentykacji, informacje o rate limitingu, specyfikację parametrów ścieżki i query, nagłówki, schemat body żądania oraz wszystkie możliwe odpowiedzi z kodami błędów.
Przejrzyj wygenerowane przykłady kodu — dokumentacja będzie zawierać polecenia cURL oraz przykłady w JavaScript/TypeScript, Python i innych językach, aby ułatwić integrację.
Dodaj wytyczne użytkownika — skill dołączy przewodnik szybkiego startu, instrukcje konfiguracji autentykacji, typowe przypadki użycia oraz najlepsze praktyki obsługi błędów.
Eksportuj dokumentację w wybranym formacie — możesz uzyskać specyfikację OpenAPI/Swagger lub dokumentację w formacie gotowym do publikacji dla deweloperów i użytkowników zewnętrznych.