Към съдържанието

Генератор на схема за JSON

Генерирайте схема за JSON от примерен JSON. Генераторът извежда типовете, задължителните свойства, схемите за елементите на масивите и често срещани формати на низове, като date-time, email, uri и uuid, и създава схема за чернова 2020-12, 2019-09 или draft-07, която можете да използвате за валидиране на заявки, документиране на API или генериране на формуляри.

Нулиране

Често задавани въпроси

Кои чернови на схема за JSON се поддържат?

Чернова 2020-12, текущата версия, използвана от OpenAPI 3.1, чернова 2019-09 и draft-07, които все още се очакват от много по-стари валидатори и инструменти. Изборът задава $schema URL; ключовите думи, генерирани от инструмента, имат едно и също значение и в трите.

Как се определят задължителните свойства?

Свойството се включва в required, когато присъства във всеки пример за съответния обект. При масив от обекти ключ, който липсва в някои елементи, не се включва в required. Изключете опцията, за да генерирате схема без списъци required.

Кои формати на низове се разпознават?

date-time, date, time, email, uri, uuid и ipv4. Формат се добавя само когато всички примерни стойности на даденото свойство отговарят на него, така че една стойност със свободен текст оставя свойството обикновен низ. Изключете разпознаването, ако не искате ключови думи за формати.

Схемата различава ли цели от десетични числа?

Да. Свойство, чиито примерни стойности са все цели числа, получава тип integer. Щом една примерна стойност има дробна част, типът става number, който приема и цели числа.

Как се описват масивите?

Масивът получава тип array и схема items, изградена съвместно от всички негови елементи. Обектите в масив се обединяват, така че схемата items изброява всеки ключ, срещащ се в който и да е елемент, а required включва само ключовете, срещащи се във всички тях.

Какво става при смесени типове?

Когато дадено свойство съдържа прости стойности от различни типове, например низ в един елемент и null в друг, схемата ги изброява като масив от типове, например ["string", "null"]. Когато обекти или масиви са смесени с други типове, генераторът използва anyOf с по една схема за всеки тип.

Добавя ли additionalProperties или ограничения?

Не. Примерът не може да покаже кои допълнителни ключове са забранени или какви са действителните минимални и максимални стойности, затова генераторът пропуска additionalProperties, minLength, maximum и подобни ключови думи. Добавете ги ръчно там, където данните ви го изискват.

Мога ли да валидирам данни с резултата?

Да. Поставете схемата и данните си във валидатора на схеми за JSON или използвайте библиотека като Ajv. Първо проверете схемата: тя отразява вашия пример, затова поле, което може да липсва или да е null в реалните данни, но не и в примера, изисква малка редакция.

Мога ли да използвам схемата в OpenAPI?

OpenAPI 3.1 използва директно JSON Schema 2020-12, така че генерираната схема може да бъде поставена под components/schemas, след като премахнете реда $schema. OpenAPI 3.0 използва по-стар поднабор; там заменете масивите от типове с nullable.

Какъв е максималният размер на входните данни?

До 1,000,000 знака от JSON, вложено до 64 нива. Примерът се анализира само за тази заявка и не се съхранява.

За OneClick Pro

OneClick Pro е безплатна колекция от над 150 уеб инструмента за ежедневна работа: преобразуване на изображения и единици, форматиране и валидиране на код, проверка на домейни и SEO, както и работа с текст, дати и числа. Всеки инструмент работи без регистрация или абонамент, а въведеното от вас се използва само за изчисляване на резултата и никога не се съхранява. Използвайте го като бърз набор от инструменти за еднократни задачи или добавете в отметките инструментите, на които разчитате всеки ден.