ToolboxKit

Konwerter JSON na TypeScript

Wklej przykład JSON, np. odpowiedź API, aby wygenerować pasujące interfejsy TypeScript. Zagnieżdżone obiekty dostają własne nazwane typy.

Twoje pliki nigdy nie opuszczają urządzenia — wszystko działa w przeglądarce.

JSON
TypeScript

Jak korzystać

  1. 1Wklej przykład JSON, najlepiej prawdziwą odpowiedź API.
  2. 2Ustaw nazwę typu głównego, np. User lub ApiResponse.
  3. 3Wybierz, czy generować deklaracje interface, czy type.
  4. 4Skopiuj wygenerowany kod lub pobierz jako types.ts.

Typy z przykładu

Wklej przykład JSON, a narzędzie wygeneruje interfejsy lub typy TypeScript opisujące jego kształt, w tym zagnieżdżone obiekty i tablice. Oszczędza czas przy pracy z odpowiedzią API, której jeszcze nie otypowałeś.

Sprawdź wynik

Pojedynczy przykład nie pokaże wszystkich przypadków. Pole, którego czasem brakuje lub które bywa null w innych odpowiedziach, może wymagać oznaczenia jako opcjonalne, a tablica mieszana może wymagać typu unii. Traktuj wynik jako punkt wyjścia.

Prywatność

Generowanie działa w przeglądarce, więc wklejony JSON nie jest wysyłany.

Najczęściej zadawane pytania

Jak wykrywane są pola opcjonalne?

Gdy JSON zawiera tablicę obiektów, generator łączy wszystkie elementy. Klucz, którego brakuje w niektórych elementach, jest oznaczany jako opcjonalny (?). Możesz też ustawić każde pole jako opcjonalne.

Jaki typ dostaje null?

Wartość null staje się typem null. Jeśli to samo pole zawiera ciąg w niektórych elementach i null w innych, otrzymasz unię, jak string | null.

Użyć interface czy type?

Dla zwykłych kształtów obiektów są w większości wymienne. Interfejsy można rozszerzać i scalać. Aliasy type działają też dla unii i innych typów. Wybierz to, czego używa już Twój kod.

Czy mój JSON jest gdzieś wysyłany?

Nie. Typy są generowane w przeglądarce, więc odpowiedzi API z prywatnymi danymi zostają na Twoim urządzeniu.

Powiązane narzędzia