Wywnioskuj schemat JSON z przykładu

Zespoły API i aplikacji generują schemat JSON z przykładowych danych, gdy projektują walidację, typy lub dokumentację.

Wywnioskuj schemat JSON z przykładu i dopracuj wygenerowaną strukturę dla swojego projektu. Działa bezpłatnie w przeglądarce, bez zakładania konta.

Jak używać

Umieść reprezentatywny przykład JSON w polu wprowadzania lub zaimportuj plik z urządzenia.
Kliknij przycisk Generuj, aby narzędzie wywnioskowało strukturę danych.
Przejrzyj schemat JSON, który pojawi się w obszarze wyników.
Sprawdź typy, właściwości i pola wymagane, a następnie skopiuj schemat.
W razie potrzeby ręcznie edytuj schemat, aby dodać ograniczenia, których narzędzie nie wykryło.

Przykład

Załóżmy, że musisz zwalidować odpowiedzi API. Wklej przykładową odpowiedź JSON, wygeneruj schemat i użyj go jako punktu wyjścia do testów. Od razu zobaczysz strukturę obiektów i tablic.

Ograniczenia i formaty

Schemat jest wnioskowany z jednego przykładu: nie może odgadnąć wariantów brakujących w próbce.
Reguły formatu (daty, adresy e-mail) lub ograniczenia liczbowe nie są dodawane automatycznie.
Słaby przykład prowadzi do niedokładnego schematu; zawsze przejrzyj wynik przed użyciem.
To narzędzie nie waliduje danych względem schematu; tworzy tylko schemat.

Gdzie odbywa się przetwarzanie

Przetwarzanie odbywa się w całości lokalnie: analiza jest wykonywana w przeglądarce i nic nie jest wysyłane na zewnątrz. Możesz więc wklejać fragmenty prawdziwych danych bez obawy o wyciek, o ile kontrolujesz swój ekran.

Częste pytania

Co się stanie, jeśli mój przykład JSON jest nieprawidłowy?

Narzędzie potrzebuje prawidłowego JSON, aby wywnioskować schemat. Jeśli przykład zawiera błąd składni, generowanie się nie powiedzie i żaden wynik się nie pojawi. Najpierw popraw JSON, a następnie ponów operację.

Czy mogę wygenerować schemat dla tablicy w korzeniu?

Tak, tablica JSON w korzeniu jest akceptowana. Wygenerowany schemat będzie wtedy opisywał tablicę, a jeśli elementy są obecne, strukturę tych elementów. Bez elementów typ obiektu pozostaje niezdefiniowany.

Czy wygenerowany schemat można bezpośrednio wykorzystać do walidacji danych?

Daje on użyteczną podstawę, ale odzwierciedla tylko dostarczony przykład. Aby walidacja była niezawodna, uzupełnij go o ograniczenia biznesowe i przetestuj na kilku reprezentatywnych zestawach danych.

Czy schemat dostanie reguły formatu dla dat i e-maili?

Nie. Reguły formatu, takie jak daty czy adresy e-mail, oraz ograniczenia liczbowe nie są automatycznie dodawane. Schemat jest wnioskowany z jednego przykładu, więc odzwierciedla tylko strukturę obecną w próbce. Przed użyciem przejrzyj typy, właściwości i pola wymagane. Jeśli potrzebujesz dodatkowych ograniczeń, dopisz je ręcznie w schemacie.

Czy narzędzie sprawdza moje dane względem schematu?

Nie. Narzędzie tylko tworzy schemat na podstawie wklejonego JSON. Nie waliduje danych ani nie porównuje ich z gotowym schematem. Aby wnioskowanie się udało, przykład musi być poprawnym JSON-em. Wynik warto uzupełnić regułami biznesowymi i przetestować na kilku reprezentatywnych zestawach danych przed użyciem w walidacji danych.