Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Umiejętność do tworzenia profesjonalnej dokumentacji API zgodnie ze standardami OpenAPI 3.1. Generujesz interaktywne dokumenty, portale dla deweloperów i przykłady kodu na podstawie specyfikacji API. Idealna do budowania portali deweloperskich, tworzenia SDK oraz poprawy jakości dokumentacji technicznej. Wspiera AsyncAPI, GraphQL i webhooks.
Jak używać
Zdefiniuj cel dokumentacji — określ, czy tworzysz nową specyfikację OpenAPI, ulepszasz istniejącą dokumentację, czy budujesz portal dla deweloperów. Zidentyfikuj docelowych użytkowników API i zakres funkcjonalności do udokumentowania.
Przygotuj lub zwaliduj specyfikację OpenAPI 3.1 — jeśli masz już specyfikację, sprawdź jej poprawność; jeśli nie, utwórz ją od zera, uwzględniając przepływy autentykacji, parametry, odpowiedzi i przykłady.
Wygeneruj dokumentację interaktywną — wykorzystaj umiejętność do stworzenia czytelnych, interaktywnych dokumentów API na podstawie specyfikacji, dodaj przykłady kodu dla różnych języków programowania.
Utwórz lub zaktualizuj portal deweloperski — zorganizuj dokumentację w strukturę portalu, dodaj przewodniki onboardingu, instrukcje integracji i best practices dla deweloperów.
Zapewnij dokładność i testowanie — zweryfikuj, że wszystkie przykłady kodu działają, przepływy autentykacji są poprawne, a dokumentacja jest aktualna w stosunku do rzeczywistego API.
Zaplanuj utrzymanie i wersjonowanie — ustal proces aktualizacji dokumentacji przy zmianach API, przygotuj przewodniki migracji dla starszych wersji i dokumentuj plan deprecacji funkcji.