Generator Schematu JSON

Generator Schematu JSON przekształca przykładowy JSON w gotowy do walidacji schemat dla API, webhooków, plików konfiguracyjnych, potoków danych i dokumentacji. Wklej reprezentatywny obiekt JSON, tablicę lub strumień NDJSON, wybierz styl wnioskowania, a narzędzie zbuduje schemat z zagnieżdżonymi właściwościami, regułami elementów tablicy, wartościami dopuszczającymi null, przykładami i czytelnymi uwagami krok po kroku dla każdej ścieżki.

Dlaczego warto używać Generatora Schematu JSON opartego na próbkach?

Ręczne pisanie JSON Schema jest precyzyjne, ale wolne, zwłaszcza gdy dane zawierają zagnieżdżone obiekty, tablice rekordów, pola opcjonalne i wartości dopuszczające null. Ten generator zapewnia strukturyzowaną wersję roboczą, która odzwierciedla zaobserwowany kształt danych JSON, a następnie wskazuje miejsca, w których nadal potrzebna jest weryfikacja przez człowieka. Jest przydatny do walidacji żądań API, kontraktów odpowiedzi, pracy z OpenAPI, ładunków webhooków, strumieni zdarzeń i schematów konfiguracji.

Jak używać

1. Wklej reprezentatywny obiekt JSON, tablicę JSON lub rekordy JSON rozdzielane nową linią do edytora próbek.
2. Wybierz wersję (draft) JSON Schema i zdecyduj, czy wnioskować pola wymagane, przykłady, podpowiedzi enum, formaty ciągów znaków oraz obiekty zamknięte. Domyślnie wersją jest Draft 2020-12, pola wymagane są ustawione na Zaobserwowane w każdym obiekcie, włączone są opcje Wykrywaj formaty, Dołącz przykłady i Wnioskuj podpowiedzi enum, a Obiekty zamknięte są wyłączone. Tytuł schematu na starcie to GeneratedSchema.
3. Kliknij Wygeneruj Generator Schematu JSON, aby wywnioskować typy, zagnieżdżone właściwości, elementy tablicy, pola dopuszczające wartość null i wskazówki walidacyjne.
4. Sprawdź wygenerowaną mapę, aby zobaczyć każdą ścieżkę, wywnioskowany typ, status wymagany, format i regułę przed użyciem schematu.
5. Skopiuj wygenerowany schemat i doprecyzuj specyficzne dla domeny reguły walidacji, takie jak dokładne zakresy, wzorce ID i specyficzne dla biznesu typy wyliczeniowe (enum).

Co wnioskuje generator

• Główne typy JSON: object, array, string, number, integer, boolean i null.
• Właściwości obiektów zagnieżdżonych i pola wymagane na podstawie tego, co pojawia się w każdym zaobserwowanym obiekcie.
• Schematy elementów tablicy poprzez scalanie zaobserwowanych elementów w próbce.
• Popularne formaty ciągów znaków, w tym email, URL, date, date-time, UUID, IPv4 oraz IPv6.
• Opcjonalne przykłady, podpowiedzi enum, zaobserwowane zakresy liczbowe oraz zaobserwowane długości ciągów znaków.

FAQ

Do czego służy ten Generator Schematu JSON?

Odczytuje przykładowy JSON i tworzy JSON Schema, który opisuje zaobserwowany kształt danych. Generator wnioskuje właściwości obiektów, tablice, typy pierwotne, wartości null, przykłady, podpowiedzi enum, pola wymagane oraz popularne formaty ciągów znaków.

Czy wygenerowany schemat może być od razu użyty produkcyjnie?

Używający go jako solidnego punktu wyjścia, a następnie go przejrzyj. Przykładowe dane nie mogą znać każdej reguły biznesowej, więc nadal może być konieczne dodanie wzorców, dokładnych zakresów, dozwolonych wartości enum, reguł wersji i bardziej rygorystycznych ustawień additionalProperties.

Które wersje (drafts) JSON Schema są obsługiwane?

Narzędzie może generować schematy dla Draft 2020-12, Draft 2019-09 oraz Draft-07 poprzez ustawienie URI $schema. Wywnioskowana struktura jest celowo kompatybilna z popularnymi walidatorami.

W jaki sposób są wnioskowane pola wymagane?

Gdy wnioskowanie pól wymaganych jest włączone, właściwość jest oznaczana jako wymagana tylko wtedy, gdy pojawia się w każdym zaobserwowanym obiekcie na tym poziomie. W przypadku tablicy obiektów oznacza to, że pole musi pojawić się w każdym przykładowym elemencie.

Czy narzędzie obsługuje tablice obiektów oraz NDJSON?

Tak. Główna tablica JSON jest traktowana jako schemat tablicy, a rekordy JSON rozdzielane nową linią są traktowane jako tablica rekordów. Właściwości elementów są scalane na podstawie zaobserwowanych próbek.