Do czego służy generator JSON Schema?

Tworzy dla Ciebie JSON Schema na podstawie przykładowych danych. Wklej próbkę, na przykład odpowiedź API, plik konfiguracyjny lub rekord z eksportu bazy danych, a otrzymasz schemat opisujący jej strukturę: typ każdej wartości, właściwości każdego obiektu, strukturę elementów każdej tablicy oraz właściwości wymagane. To szybki sposób na rozpoczęcie pracy nad dokumentacją API, specyfikacjami OpenAPI, walidacją formularzy lub kontraktami danych, które możesz później dopracować ręcznie.

Jak korzystać z narzędzia

  1. Wklej lub wpisz przykładowy JSON w polu wejściowym.
  2. Wybierz wersję roboczą JSON Schema dla wiersza $schema: Draft 2020-12 lub Draft 7.
  3. Wybierz, czy właściwości mają być oznaczone jako wymagane.
  4. Skopiuj schemat lub pobierz go jako schema.json.

Jeśli próbka nie jest prawidłowym JSON-em, narzędzie wskaże wiersz i kolumnę z błędem oraz go zaznaczy.

Jak powstaje schemat

  • Każda wartość otrzymuje typ JSON: string, boolean, null, object, array oraz integer dla liczb całkowitych lub number dla liczb z częścią dziesiętną. Tablica zawierająca liczby całkowite i dziesiętne otrzymuje typ number, który obejmuje oba przypadki.
  • Dla każdego klucza obiekty otrzymują wpis properties z opisem utworzonym w ten sam sposób, na tyle głęboko, na ile sięga próbka.
  • Tablice otrzymują jeden schemat items, który pasuje do wszystkich elementów. Jeśli elementami są obiekty, ich właściwości są łączone, więc lista rekordów daje jeden schemat rekordu.
  • Wartości o różnych typach otrzymują wszystkie typy na liście, na przykład ["string", "null"], albo anyOf, gdy wymieszane są obiekty i inne wartości.
  • Pusta tablica otrzymuje "type": "array" bez items, ponieważ nie ma elementów, które można opisać.

Właściwości wymagane

Gdy opcja „Oznacz właściwości jako wymagane” jest włączona, każdy obiekt wyświetla swoje klucze w sekcji required. W przypadku tablicy obiektów właściwość jest wymagana tylko wtedy, gdy występuje w każdym elemencie: na liście członków, gdzie tylko niektórzy mają właściwość favorite, jest ona opcjonalna. Wyłącz tę opcję, aby uzyskać schemat bez list required.

Czego nie da się ustalić na podstawie próbki

Schemat utworzony na podstawie jednego przykładu uwzględnia tylko to, co pokazuje ten przykład. Nie może ustalić, które wartości tekstowe są adresami e-mail lub datami, jakie zakresy mogą przyjmować liczby ani czy właściwość widoczna raz może być również pominięta. W razie potrzeby ręcznie dodaj format, minimum, maxLength, enum lub pattern, a następnie sprawdź dane za pomocą walidatora JSON Schema.

Jak to działa

Narzędzie korzysta z genson-js, portu GenSON schema buildera napisanego w JavaScript. Zapisywane słowa kluczowe mają takie samo znaczenie w Draft 7 i Draft 2020-12, więc wybrana wersja robocza zmienia tylko wiersz $schema. Wszystko działa w przeglądarce: próbka nigdy nie jest przesyłana.

Funkcje

  • JSON Schema utworzone na podstawie dowolnej próbki JSON
  • Automatycznie rozpoznawane typy, zagnieżdżone obiekty i tablice
  • Elementy tablicy łączone w jeden schemat z wykrywaniem właściwości opcjonalnych
  • Draft 2020-12 lub Draft 7
  • Właściwości wymagane można włączyć lub wyłączyć
  • Kopiowanie lub pobieranie jako schema.json
  • Działa w przeglądarce