Wywnioskuj interfejs TypeScript z JSON

Zespoły API i aplikacji generują interfejs TypeScript z przykładu JSON, gdy projektują typy dla odpowiedzi lub danych wejściowych.

Wywnioskuj interfejs TypeScript z JSON i dopracuj wygenerowaną strukturę dla swojego projektu. Działa w przeglądarce bez zakładania konta.

Jak używać

Wklej przykład JSON w polu wprowadzania lub zaimportuj zgodny plik.
Kliknij Generuj, aby utworzyć interfejs TypeScript.
Wynik pokazuje typy wywnioskowane z właściwości w Twoim przykładzie.
Przejrzyj pola, typy i możliwe opcje, a następnie skopiuj kod.
Użyj Wyczyść, aby wyczyścić pola i przetestować inny przykład.

Przykład

Otrzymujesz odpowiedź API i chcesz szybko typować jej zawartość. Wklej przykład JSON, wygeneruj interfejs TypeScript, a następnie zintegruj go ze swoim projektem. Oszczędzasz czas na podstawowych deklaracjach typów.

Ograniczenia i formaty

Wygenerowany interfejs opiera się na pojedynczym przykładzie; pola opcjonalne nie są wykrywane.
Złożone typy, takie jak unie lub literały, nie są odgadywane.
Nazwy typów mogą być ogólne i wymagać zmiany.
Narzędzie nie kompiluje kodu TypeScript; tworzy tylko propozycję.

Gdzie odbywa się przetwarzanie

Wszystko dzieje się w przeglądarce: analiza i generowanie są lokalne, bez wysyłania danych na zewnątrz. Możesz więc pracować na fragmentach prawdziwych odpowiedzi, zachowując poufność.

Częste pytania

Czy pola opcjonalne są oznaczane w wygenerowanym interfejsie?

Narzędzie opiera się na pojedynczym przykładzie. Jeśli pole jest obecne, jest uważane za wymagane. Pola nieobecne w przykładzie nie mogą zostać odgadnięte jako opcjonalne. Będziesz musiał dostosować je ręcznie.

Czy mogę generować interfejsy dla tablic obiektów?

Tak, jeśli Twój przykład zawiera tablicę obiektów, narzędzie wnioskuje typ elementu i odzwierciedla go w interfejsie. Sprawdź, czy wygenerowany typ odpowiada strukturze każdego elementu.

Czy wygenerowany kod można bezpośrednio skompilować?

Wygenerowany interfejs TypeScript jest w większości przypadków poprawny składniowo, ale może zawierać zbyt ogólne typy lub nazwy do dostosowania. Przejrzyj i popraw go przed integracją z projektem.

Czy narzędzie wykrywa typy unii lub typy literałowe?

Nie, narzędzie nie odgaduje złożonych typów, takich jak unie czy typy literałowe. Opiera się na jednym przykładzie JSON i wywnioskowuje typy z obecnych właściwości. Dlatego wynik może wymagać ręcznej korekty, zwłaszcza gdy dane w rzeczywistości mogą przyjmować różne kształty. Przejrzyj wygenerowany interfejs i dostosuj nazwy oraz typy do swojego projektu.

Czy nazwy typów są dopasowane do mojego projektu?

Nie, nazwy typów mogą być ogólne i wymagać zmiany. Narzędzie generuje propozycję interfejsu na podstawie próbki JSON, więc nie zna konwencji nazewnictwa w Twoim projekcie. Po wygenerowaniu kodu sprawdź nazwy pól, interfejsów i typów pomocniczych. Jeśli wynik ma być używany w większym projekcie, dostosuj go ręcznie i upewnij się, że odpowiada strukturze danych.