Z przykładowej odpowiedzi do typów
Praca z API zaczyna się prawie zawsze tak samo: masz odpowiedź JSON i potrzebujesz dla niej typu. Wklej odpowiedź po lewej, a po prawej pojawi się odpowiedni TypeScript, gotowy do pliku .ts. Niczego nie trzeba pisać ręcznie, nie trzeba też liczyć nawiasów klamrowych, a ładunek z dziesięcioma poziomami zajmuje tyle samo czasu co ten z dwoma.
Od ładunku do deklaracji
- Wklej JSON do lewego pola albo naciśnij Przykład, aby zobaczyć działanie.
- Ustaw nazwę głównego typu, na przykład
UserlubApiResponse. - Wybierz
interfacealbotypei zaznacz export lub tylko do odczytu, jeśli ich potrzebujesz. - Sprawdź wynik po prawej. Błąd składni jest zgłaszany zamiast typów.
- Użyj Kopiuj lub Pobierz .ts, aby zabrać kod. Plik dostaje nazwę głównego typu.
Jak wyznaczane są typy
- Ciągi znaków, liczby, wartości logiczne i null zamieniają się w odpowiedni typ TypeScript.
- Zagnieżdżony obiekt staje się własnym interfejsem, nazwanym od klucza w PascalCase. Klucz
shipping_addressdajeShippingAddress. - W tablicach wszystkie elementy są łączone. Klucz występujący tylko w niektórych dostaje znak zapytania, a wartości różnego rodzaju tworzą unię, np.
string | number. - Dwa obiekty o dokładnie tym samym kształcie dzielą jeden interfejs zamiast dwóch kopii.
- Pusta tablica daje
unknown[], pusty obiekt dajeRecord<string, unknown>.
Granice zgadywania z jednej próbki
Próbka pokazuje tylko to, co zawiera. Pole zawsze wypełnione w twoim przykładzie może mieć w produkcji wartość null, a liczba wyglądająca jak identyfikator gdzie indziej bywa ciągiem znaków. Daty przychodzą jako ciągi, więc są typowane jako string. Traktuj wynik jak pierwszy szkic i dopracuj go ręcznie albo sprawdzaj prawdziwe odpowiedzi w czasie działania, jeśli dane nie zależą od ciebie.
Twoje dane pozostają prywatne
Konwersja odbywa się na stronie. Odpowiedzi z produkcji, tokeny i dane osobowe we wklejonej próbce nie trafiają na serwer, więc możesz używać prawdziwych danych.