Przejdź do treści

Generator schematów JSON

Generuj schemat JSON na podstawie przykładowego JSON. Generator wnioskuje typy, wymagane właściwości, schematy elementów tablic oraz popularne formaty ciągów znaków, takie jak data i godzina, adres e-mail, uri i uuid. Tworzy schemat zgodny z wersją roboczą 2020-12, 2019-09 lub draft-07, którego możesz użyć do walidacji żądań, dokumentowania API lub generowania formularzy.

Resetuj

Najczęściej zadawane pytania

Które wersje robocze schematu JSON są obsługiwane?

Wersja robocza 2020-12, czyli aktualna wersja używana przez OpenAPI 3.1, wersja robocza 2019-09 oraz draft-07, której nadal oczekuje wiele starszych walidatorów i narzędzi. Wybór określa $schema URL; słowa kluczowe generowane przez narzędzie oznaczają to samo we wszystkich trzech wersjach.

Jak określane są wymagane właściwości?

Właściwość jest wymieniana w sekcji required, jeśli występuje w każdym przykładzie danego obiektu. W tablicy obiektów klucz nieobecny w niektórych elementach jest pomijany w sekcji required. Wyłącz tę opcję, aby utworzyć schemat bez list wymaganych właściwości.

Jakie formaty ciągów znaków są wykrywane?

date-time, date, time, email, uri, uuid i ipv4. Format jest dodawany tylko wtedy, gdy każda przykładowa wartość danej właściwości jest z nim zgodna, więc pojedyncza wartość tekstowa sprawi, że właściwość pozostanie zwykłym ciągiem znaków. Wyłącz wykrywanie, jeśli nie chcesz słów kluczowych określających format.

Czy schemat odróżnia liczby całkowite od dziesiętnych?

Tak. Właściwość, której wszystkie przykładowe wartości są liczbami całkowitymi, otrzymuje typ integer. Gdy tylko jedna z nich ma część ułamkową, typ zmienia się na number, który obejmuje również liczby całkowite.

Jak opisywane są tablice?

Tablica otrzymuje typ array oraz schemat items utworzony na podstawie wszystkich jej elementów. Obiekty w tablicy są łączone, więc schemat elementów wymienia każdy klucz występujący w dowolnym elemencie, a sekcja required obejmuje tylko klucze obecne we wszystkich.

Co dzieje się przy różnych typach?

Jeśli właściwość zawiera proste wartości różnych typów, na przykład ciąg znaków w jednym elemencie i null w innym, schemat wymienia je jako tablicę typów, na przykład ["string", "null"]. Gdy obiekty lub tablice występują wraz z wartościami innych typów, generator używa anyOf z osobnym schematem dla każdego typu.

Czy dodawane są additionalProperties lub ograniczenia?

Nie. Przykład nie pokazuje, które dodatkowe klucze są zabronione ani jakie są rzeczywiste wartości minimalne i maksymalne, dlatego generator pomija additionalProperties, minLength, maximum i podobne słowa kluczowe. Dodaj je ręcznie tam, gdzie wymagają tego Twoje dane.

Czy mogę walidować dane za pomocą wyniku?

Tak. Wklej schemat i swoje dane do JSON Schema Validator albo użyj ich z biblioteką taką jak Ajv. Najpierw sprawdź schemat: odzwierciedla on przykład, więc jeśli w rzeczywistych danych pole może być nieobecne lub mieć wartość null, a nie występuje tak w przykładzie, trzeba go nieznacznie zmienić.

Czy mogę użyć schematu w OpenAPI?

OpenAPI 3.1 używa bezpośrednio schematu JSON Schema 2020-12, więc wygenerowany schemat można umieścić w components/schemas po usunięciu wiersza $schema. OpenAPI 3.0 używa starszego podzbioru; w tym przypadku zastąp tablice typów wartością nullable.

Jak duże mogą być dane wejściowe?

Do 1,000,000 znaków JSON, z zagnieżdżeniem do 64 poziomów. Próbka jest analizowana tylko na potrzeby tego żądania i nie jest zapisywana.

O OneClick Pro

OneClick Pro to bezpłatny zbiór ponad 150 narzędzi internetowych do codziennej pracy: konwertowania obrazów i jednostek, formatowania i walidowania kodu, sprawdzania domen i SEO oraz pracy z tekstem, datami i liczbami. Każde narzędzie działa bez rejestracji i subskrypcji, a wprowadzone dane służą wyłącznie do obliczenia wyniku i nigdy nie są przechowywane. Używaj go jako podręcznego zestawu narzędzi do jednorazowych zadań lub dodaj do zakładek te, z których korzystasz każdego dnia.