openapi-to-typescript

Umożliwia automatyczne generowanie typów TypeScript z plików OpenAPI 3.0 w formacie JSON lub YAML. Skill wyodrębnia schematy i endpointy z Twojej specyfikacji, a następnie tworzy gotowe interfejsy oraz type guardy, które chronią Twój kod przed błędami typów. Idealne dla deweloperów pracujących z API – zamiast ręcznego pisania definicji typów, otrzymujesz wygenerowany plik TypeScript gotowy do użycia w projekcie.

1. Przygotuj plik OpenAPI w formacie JSON lub YAML (musi być wersja 3.0.x). Plik powinien zawierać sekcje paths (endpointy) i components.schemas (definicje typów).

2. Uruchom skill i podaj ścieżkę do pliku OpenAPI. Jeśli ścieżka nie zostanie podana, skill poprosi Cię o nią.

3. Skill automatycznie waliduje plik – sprawdza, czy pole openapi zaczyna się od "3.0", czy istnieją sekcje paths i components.schemas. Jeśli walidacja się nie powiedzie, otrzymasz komunikat o błędzie.

4. Skill ekstrahuje schematy z components.schemas i definicje żądań/odpowiedzi z paths, a następnie mapuje typy OpenAPI na TypeScript (string, number, boolean, obiekty, tablice itp.).

5. Wygenerowany plik TypeScript zawiera interfejsy dla każdego schematu oraz type guardy do walidacji danych w runtime. Domyślnie plik zapisywany jest jako types/api.ts w bieżącym katalogu – możesz zmienić lokalizację.

6. Otrzymujesz gotowy plik TypeScript, który możesz od razu zaimportować w swoim projekcie i używać do typowania requestów i responsów z API.