json-to-typescript-interface-generator
Generate TypeScript interfaces from JSON data or API responses. Auto-type your APIs instantly. Free CLI tool for TypeScript developers.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Generate TypeScript interfaces from JSON data or API responses. Auto-type your APIs instantly. Free CLI tool for TypeScript developers.
How to use
Zainstaluj narzędzie globalnie za pomocą npm: npm install -g @lxgicstudios/json-to-ts. Alternatywnie możesz uruchomić je bez instalacji, używając npx.
Przygotuj dane wejściowe — możesz użyć pliku JSON, URL API lub danych ze standardowego wejścia (pipe). Na przykład, jeśli masz plik data.json, uruchom: npx @lxgicstudios/json-to-ts data.json. Narzędzie domyślnie nazwie główny interfejs "Root".
Jeśli chcesz zmienić nazwę interfejsu, dodaj flagę -n: npx @lxgicstudios/json-to-ts data.json -n User. To utworzy interfejs o nazwie User zamiast Root.
Aby pobrać typy bezpośrednio z API, podaj URL zamiast ścieżki pliku: npx @lxgicstudios/json-to-ts https://api.example.com/users -n User. Narzędzie automatycznie pobierze odpowiedź i wygeneruje typy.
Jeśli chcesz zapisać wygenerowane interfejsy do pliku, użyj flagi -o: npx @lxgicstudios/json-to-ts data.json -o src/types/api.ts. To zapisze wszystkie interfejsy (w tym zagnieżdżone obiekty) w określonym pliku.
Dla zaawansowanych przypadków możesz użyć pipe'u, na przykład: curl https://api.example.com/data | npx @lxgicstudios/json-to-ts -n ApiResponse. To pozwala integrować narzędzie z innymi poleceniami CLI.