JSON na TypeScript

Co robi narzędzie

Generator JSON na TypeScript odczytuje przykładowy JSON, na przykład odpowiedź API lub plik konfiguracyjny, i pisze interfejsy TypeScript, które go opisują. Zamiast ręcznie wpisywać każde pole, wklejasz jedną prawdziwą odpowiedź i dostajesz typy gotowe do użycia w kodzie, dla wyników fetch, stanu Reduxa czy danych testowych.

Generator sprawdza każdą wartość, nie tylko pierwszą. Liczby stają się number, tekst string, zagnieżdżone obiekty dostają własne interfejsy, a elementy tablicy są łączone, więc pole obecne tylko w niektórych elementach jest oznaczane jako opcjonalne, a pole czasem równe null jest typowane jako dopuszczające null.

Jak używać

1. Wklej JSON do pola wejściowego, wgraj plik .json lub kliknij Przykład.
2. Ustaw nazwę typu głównego i wybierz styl: interface lub type, null jako | null lub jako pola opcjonalne, właściwości readonly oraz czy każda deklaracja ma mieć export.
3. Skopiuj TypeScript lub pobierz go jako plik .ts.

Nieprawidłowy JSON jest zgłaszany z wierszem i kolumną błędu, więc możesz od razu poprawić przykład.

Przykład

Ten JSON:

{ "id": 7, "name": "Ada", "tags": ["admin"], "manager": { "id": 1, "email": null } }

zamienia się w takie deklaracje:

export interface Root {
  id: number;
  name: string;
  tags: string[];
  manager: Manager;
}

export interface Manager {
  id: number;
  email: null;
}

Wskazówki

• Jeden przykład pokazuje tylko to, co zawiera. Jeśli pole może być napisem lub null, dodaj oba przypadki albo umieść kilka przykładów w tablicy, aby zostały połączone.
• Nazwy pól, które nie są poprawnymi identyfikatorami, takie jak first-name, są zapisywane w cudzysłowie, więc wynik zawsze się kompiluje.
• Wynik to punkt wyjścia. Zawężaj pola tekstowe do unii literałów lub Date, gdy wiesz więcej niż przykład.
• Potrzebujesz Go? Konwerter JSON na Go używa tego samego wnioskowania, by pisać struktury z tagami json.